headless.c File Reference

#include <freeldr.h>
#include <cportlib/cportlib.h>
#include <cportlib/uartinfo.h>
#include "ntldropts.h"
#include <debug.h>
#include <pshpack1.h>
#include <poppack.h>

Include dependency graph for headless.c:

Go to the source code of this file.

Classes
struct	_SYSID_UUID_ENTRY

Macros
#define	SYSID_TYPE_UUID   "_UUID_"
#define	SYSID_UUID_DATA_SIZE   16
#define	strtoulptr   strtoul

Typedefs
typedef struct _SYSID_UUID_ENTRY	SYSID_UUID_ENTRY
typedef struct _SYSID_UUID_ENTRY *	PSYSID_UUID_ENTRY

Functions
VOID	WinLdrLoadGUID (_Out_ PGUID SystemGuid)
BOOLEAN	WinLdrPortInitialize (_In_ ULONG BaudRate, _In_ ULONG PortNumber, _In_ PUCHAR PortAddress, _In_ BOOLEAN TerminalConnected, _Out_ PULONG PortId)
VOID	WinLdrPortPutByte (_In_ ULONG PortId, _In_ UCHAR Byte)
BOOLEAN	WinLdrPortGetByte (_In_ ULONG PortId, _Out_ PUCHAR Byte)
BOOLEAN	WinLdrPortPollOnly (_In_ ULONG PortId)
VOID	WinLdrEnableFifo (_In_ ULONG PortId, _In_ BOOLEAN Enable)
VOID	WinLdrInitializeHeadlessPort (VOID)
VOID	WinLdrSetupEms (_In_ PCSTR BootOptions)

Variables
HEADLESS_LOADER_BLOCK	LoaderRedirectionInformation
BOOLEAN	WinLdrTerminalConnected
ULONG	WinLdrTerminalDeviceId
ULONG	WinLdrTerminalDelay
CPPORT	Port [4]

Macro Definition Documentation

strtoulptr

#define strtoulptr   strtoul

SYSID_TYPE_UUID

#define SYSID_TYPE_UUID   "_UUID_"

Definition at line 19 of file headless.c.

SYSID_UUID_DATA_SIZE

#define SYSID_UUID_DATA_SIZE   16

Definition at line 20 of file headless.c.

Typedef Documentation

PSYSID_UUID_ENTRY

typedef struct _SYSID_UUID_ENTRY * PSYSID_UUID_ENTRY

SYSID_UUID_ENTRY

typedef struct _SYSID_UUID_ENTRY SYSID_UUID_ENTRY

Function Documentation

WinLdrEnableFifo()

VOID WinLdrEnableFifo	(	_In_ ULONG	PortId,
		_In_ BOOLEAN	Enable
	)

Definition at line 163 of file headless.c.

{
    CpEnableFifo(Port[PortId].Address, Enable);
}

Referenced by WinLdrInitializeHeadlessPort().

WinLdrInitializeHeadlessPort()

VOID WinLdrInitializeHeadlessPort

(

VOID

)

Definition at line 171 of file headless.c.

{
    ULONG PortNumber, BaudRate;
    PUCHAR PortAddress;
    PCSTR AnsiReset = "\x1B[m";
    ULONG i;
 
    PortNumber = LoaderRedirectionInformation.PortNumber;
    PortAddress = LoaderRedirectionInformation.PortAddress;
    BaudRate = LoaderRedirectionInformation.BaudRate;
 
    /* Pick a port address */
    if (PortNumber)
    {
        if (!PortAddress)
        {
            if (PortNumber < 1 || PortNumber > MAX_COM_PORTS)
                PortNumber = 1;
            LoaderRedirectionInformation.PortAddress = UlongToPtr(BaseArray[PortNumber]);
        }
    }
    else
    {
        /* No number, so no EMS */
        WinLdrTerminalConnected = FALSE;
        return;
    }
 
    /* Call arch code to initialize the port */
    PortAddress = LoaderRedirectionInformation.PortAddress;
    WinLdrTerminalConnected = WinLdrPortInitialize(BaudRate,
                                                   PortNumber,
                                                   PortAddress,
                                                   WinLdrTerminalConnected,
                                                   &WinLdrTerminalDeviceId);
    if (WinLdrTerminalConnected)
    {
        /* Port seems usable, set it up and get the BIOS GUID */
        WinLdrEnableFifo(WinLdrTerminalDeviceId, TRUE);
 
        WinLdrLoadGUID(&LoaderRedirectionInformation.SystemGUID);
 
        /* Calculate delay in us based on the baud, assume 9600 if none given */
        if (!BaudRate)
        {
            BaudRate = 9600;
            LoaderRedirectionInformation.BaudRate = BaudRate;
        }
 
        WinLdrTerminalDelay = (10 * 1000 * 1000) / (BaudRate / 10) / 6;
 
        /* Send an ANSI reset sequence to get the terminal up and running */
        for (i = 0; i < strlen(AnsiReset); i++)
        {
            WinLdrPortPutByte(WinLdrTerminalDeviceId, AnsiReset[i]);
            StallExecutionProcessor(WinLdrTerminalDelay);
        }
    }
}

Referenced by WinLdrSetupEms().

WinLdrLoadGUID()

VOID WinLdrLoadGUID

(

_Out_ PGUID

SystemGuid

)

Definition at line 49 of file headless.c.

{
#if (defined(_M_IX86) || defined(_M_AMD64)) && !defined(UEFIBOOT)
    PSYSID_UUID_ENTRY CurrentAddress;
 
    CurrentAddress = (PSYSID_UUID_ENTRY)0xE0000;
    while (CurrentAddress < (PSYSID_UUID_ENTRY)0x100000)
    {
        if (RtlCompareMemory(&CurrentAddress->Type, SYSID_TYPE_UUID, 6) == 6)
        {
            RtlCopyMemory(SystemGuid, &CurrentAddress->UUID, SYSID_UUID_DATA_SIZE);
            return;
        }
        CurrentAddress = (PSYSID_UUID_ENTRY)((ULONG_PTR)CurrentAddress + 1);
    }
#else
    _WARN("WinLdrLoadGUID needs SMBIOS table reading implementation on this platform!");
#endif
 
    RtlZeroMemory(SystemGuid, SYSID_UUID_DATA_SIZE);
}

Referenced by WinLdrInitializeHeadlessPort().

WinLdrPortGetByte()

BOOLEAN WinLdrPortGetByte	(	_In_ ULONG	PortId,
		_Out_ PUCHAR	Byte
	)

Definition at line 146 of file headless.c.

{
    return CpGetByte(&Port[PortId], Byte, TRUE, FALSE) == CP_GET_SUCCESS;
}

WinLdrPortInitialize()

BOOLEAN WinLdrPortInitialize	(	_In_ ULONG	BaudRate,
		_In_ ULONG	PortNumber,
		_In_ PUCHAR	PortAddress,
		_In_ BOOLEAN	TerminalConnected,
		_Out_ PULONG	PortId
	)

Definition at line 74 of file headless.c.

{
    /* Set the default baud rate */
    if (BaudRate == 0)
        BaudRate = DEFAULT_BAUD_RATE;
 
    /* Check if the port or address is given */
    if (PortNumber)
    {
        /* Pick correct address for port */
        if (!PortAddress)
        {
            if (PortNumber < 1 || PortNumber > MAX_COM_PORTS)
                PortNumber = MAX_COM_PORTS;
            PortAddress = UlongToPtr(BaseArray[PortNumber]);
        }
    }
    else
    {
        /* Pick correct port for address */
#if defined(SARCH_PC98)
        static const ULONG TestPorts[] = {1, 2};
#else
        static const ULONG TestPorts[] = {2, 1};
#endif
        PortAddress = UlongToPtr(BaseArray[TestPorts[0]]);
        if (CpDoesPortExist(PortAddress))
        {
            PortNumber = TestPorts[0];
        }
        else
        {
            PortAddress = UlongToPtr(BaseArray[TestPorts[1]]);
            if (!CpDoesPortExist(PortAddress))
                return FALSE;
            PortNumber = TestPorts[1];
        }
    }
 
    /* Not yet supported */
    ASSERT(LoaderRedirectionInformation.IsMMIODevice == FALSE);
 
    /* Check if port exists */
    if (CpDoesPortExist(PortAddress))
    {
        /* Initialize port for the first time, or re-initialize if specified */
        if (!!TerminalConnected == (Port[PortNumber - 1].Address != NULL))
        {
            /* Initialize the port and return it */
            CpInitialize(&Port[PortNumber - 1], PortAddress, BaudRate);
            *PortId = PortNumber - 1;
            return TRUE;
        }
    }
 
    return FALSE;
}

Referenced by WinLdrInitializeHeadlessPort().

WinLdrPortPollOnly()

BOOLEAN WinLdrPortPollOnly

(

_In_ ULONG

PortId

)

Definition at line 154 of file headless.c.

{
    UCHAR Dummy;
 
    return CpGetByte(&Port[PortId], &Dummy, FALSE, TRUE) == CP_GET_SUCCESS;
}

WinLdrPortPutByte()

VOID WinLdrPortPutByte	(	_In_ ULONG	PortId,
		_In_ UCHAR	Byte
	)

Definition at line 138 of file headless.c.

{
    CpPutByte(&Port[PortId], Byte);
}

Referenced by WinLdrInitializeHeadlessPort().

WinLdrSetupEms()

VOID WinLdrSetupEms

(

_In_ PCSTR

BootOptions

)

Definition at line 232 of file headless.c.

{
    PCSTR Option;
 
    /* Start fresh */
    RtlZeroMemory(&LoaderRedirectionInformation, sizeof(HEADLESS_LOADER_BLOCK));
    LoaderRedirectionInformation.PciDeviceId = PCI_INVALID_VENDORID;
 
    /* Use a direction port if one was given, or use ACPI to detect one instead */
    Option = NtLdrGetOption(BootOptions, "redirect=");
    if (Option)
    {
        Option += 9;
        if (_strnicmp(Option, "com", 3) == 0)
        {
            Option += 3;
            LoaderRedirectionInformation.PortNumber = atoi(Option);
            LoaderRedirectionInformation.TerminalType = 1; // VT100+
        }
        else if (_strnicmp(Option, "usebiossettings", 15) == 0)
        {
            // FIXME: TODO!
            UiDrawStatusText("ACPI SRT/SPCR Table Not Supported...");
            return;
        }
        else
        {
#ifdef _WIN64
#define strtoulptr strtoull
#else
#define strtoulptr strtoul
#endif
            LoaderRedirectionInformation.PortAddress = (PUCHAR)strtoulptr(Option, 0, 16);
            if (LoaderRedirectionInformation.PortAddress)
                LoaderRedirectionInformation.PortNumber = 3;
        }
    }
 
    /* Use a direction baudrate if one was given */
    Option = NtLdrGetOption(BootOptions, "redirectbaudrate=");
    if (Option)
    {
        Option += 17;
        // LoaderRedirectionInformation.BaudRate = atoi(Option);
        if (strncmp(Option, "115200", 6) == 0)
        {
            LoaderRedirectionInformation.BaudRate = 115200;
        }
        else if (strncmp(Option, "57600", 5) == 0)
        {
            LoaderRedirectionInformation.BaudRate = 57600;
        }
        else if (strncmp(Option, "19200", 5) == 0)
        {
            LoaderRedirectionInformation.BaudRate = 19200;
        }
        else
        {
            LoaderRedirectionInformation.BaudRate = 9600;
        }
    }
 
    /* Enable headless support if parameters were found */
    if (LoaderRedirectionInformation.PortNumber)
    {
        if (!LoaderRedirectionInformation.BaudRate)
        {
            LoaderRedirectionInformation.BaudRate = 9600;
        }
 
        WinLdrInitializeHeadlessPort();
    }
}

Referenced by LoadAndBootWindowsCommon().

Variable Documentation

LoaderRedirectionInformation

HEADLESS_LOADER_BLOCK LoaderRedirectionInformation

Definition at line 33 of file headless.c.

Referenced by WinLdrInitializeHeadlessPort(), WinLdrInitializePhase1(), WinLdrPortInitialize(), and WinLdrSetupEms().

Port

CPPORT Port[4]

Initial value:

=
{
    {NULL, 0, TRUE},
    {NULL, 0, TRUE},
    {NULL, 0, TRUE},
    {NULL, 0, TRUE}
}

Definition at line 38 of file headless.c.

Referenced by __inbyte(), __inbytestring(), __indword(), __indwordstring(), __inword(), __inwordstring(), __outbyte(), __outbytestring(), __outdword(), __outdwordstring(), __outword(), __outwordstring(), _inp(), _inpd(), _inpw(), _outp(), _outpd(), _outpw(), AddItem(), AddrBuildAddress(), AddrFindShared(), AddrGetAddress(), AddrSearchFirst(), AllocatePort(), CloneAddrInfo(), CmosReadData(), CmosWriteAddress(), CmosWriteData(), Cp16550ReadLsr(), CpGetByte(), CpInitialize(), CpPutByte(), CpReadLsr(), CpSetBaud(), DbgkForwardException(), DbgkpSendApiMessageLpc(), DeallocatePort(), DECLARE_INTERFACE_(), DetectSerialMouse(), DmaPageReadPort(), DmaPageWritePort(), DmaReadPort(), DmaWritePort(), DnsAddr_BuildFromIp4(), DnsAddr_BuildFromIp6(), CWebServiceLibCurl::DoRequest(), CWebServiceWinInet::DoRequest(), DumpInfo(), EHCI_PollController(), EHCI_RH_ChirpRootPort(), EHCI_RH_ClearFeaturePortConnectChange(), EHCI_RH_ClearFeaturePortEnable(), EHCI_RH_ClearFeaturePortEnableChange(), EHCI_RH_ClearFeaturePortOvercurrentChange(), EHCI_RH_ClearFeaturePortPower(), EHCI_RH_ClearFeaturePortResetChange(), EHCI_RH_ClearFeaturePortSuspend(), EHCI_RH_ClearFeaturePortSuspendChange(), EHCI_RH_FinishReset(), EHCI_RH_GetPortStatus(), EHCI_RH_PortResetComplete(), EHCI_RH_PortResumeComplete(), EHCI_RH_SetFeaturePortEnable(), EHCI_RH_SetFeaturePortPower(), EHCI_RH_SetFeaturePortReset(), EHCI_RH_SetFeaturePortSuspend(), EHCI_StartController(), EmulatorReadIo(), EmulatorWriteIo(), FAST486_OPCODE_HANDLER(), Fast486IoReadCallback(), Fast486IoWriteCallback(), GetDiskBySCSI(), GetPortName(), GetSerialMousePnpId(), HaliHandlePCIConfigSpaceAccess(), HalpReportResourceUsage(), i8042PacketWrite(), i8042SynchWritePort(), CMiniportWaveStreamCMI::Init(), InitializeSerialPort(), InstallSubdevice(), IopCompleteRequest(), IOReadB(), IOReadD(), IOReadStrB(), IOReadStrD(), IOReadStrW(), IOReadW(), IOWriteB(), IOWriteD(), IOWriteStrB(), IOWriteStrD(), IOWriteStrW(), IOWriteW(), IsaBusReadDataPortRegister(), IsaBusReadSerialIsolationRegister(), KdDebuggerInitialize0(), LlbHwGetUartBase(), LookupAddressForName(), LpcpClosePort(), LpcpCopyRequestData(), LpcpCreatePort(), LpcpDeletePort(), LpcpDestroyPortQueue(), LpcpFindDataInfoMessage(), LpcpFreeDataInfoMessage(), LpcpFreePortClientSecurity(), LpcpInitializePortQueue(), LpcpSaveDataInfoMessage(), LpcpSetPortToThread(), LpcpValidateClientPort(), LpcRequestPort(), LpcRequestWaitReplyPort(), NdisImmediateReadPortUchar(), NdisImmediateReadPortUlong(), NdisImmediateReadPortUshort(), NdisImmediateWritePortUchar(), NdisImmediateWritePortUlong(), NdisImmediateWritePortUshort(), NewAddrInfo(), NewPortDMus(), NewPortWaveCyclic(), NewPortWavePci(), NewPortWaveRT(), NtCompleteConnectPort(), NtImpersonateClientOfPort(), NtReplyPort(), NtReplyWaitReceivePortEx(), NtRequestPort(), NtRequestWaitReplyPort(), NtSecureConnectPort(), OHCI_RH_ClearFeaturePortConnectChange(), OHCI_RH_ClearFeaturePortEnable(), OHCI_RH_ClearFeaturePortEnableChange(), OHCI_RH_ClearFeaturePortOvercurrentChange(), OHCI_RH_ClearFeaturePortPower(), OHCI_RH_ClearFeaturePortResetChange(), OHCI_RH_ClearFeaturePortSuspend(), OHCI_RH_ClearFeaturePortSuspendChange(), OHCI_RH_GetPortStatus(), OHCI_RH_SetFeaturePortEnable(), OHCI_RH_SetFeaturePortPower(), OHCI_RH_SetFeaturePortReset(), OHCI_RH_SetFeaturePortSuspend(), PicReadCommand(), PicReadData(), PicWriteCommand(), PicWriteData(), PinPropertyHandler(), PitReadPort(), PitWritePort(), PortInB(), PortInsB(), PortInsW(), PortInW(), PortOutB(), PortOutsB(), PortOutsW(), PortOutW(), PpiReadPort(), PS2PortQueueRead(), PS2QueuePush(), PS2ReadControl(), PS2ReadData(), PS2SendCommand(), PS2WriteControl(), QueryDNS(), READ_PORT_BUFFER_UCHAR(), READ_PORT_BUFFER_ULONG(), READ_PORT_BUFFER_USHORT(), READ_PORT_UCHAR(), READ_PORT_ULONG(), READ_PORT_USHORT(), RegisterIoPort(), RtlIpv4AddressToStringExA(), RtlIpv4AddressToStringExW(), RtlIpv4StringToAddressExA(), RtlIpv4StringToAddressExW(), RtlIpv6AddressToStringExA(), RtlIpv6AddressToStringExW(), RtlIpv6StringToAddressExA(), RtlIpv6StringToAddressExW(), ScsiPortReadPortBufferUchar(), ScsiPortReadPortBufferUlong(), ScsiPortReadPortBufferUshort(), ScsiPortReadPortUchar(), ScsiPortReadPortUlong(), ScsiPortReadPortUshort(), ScsiPortWritePortBufferUchar(), ScsiPortWritePortBufferUlong(), ScsiPortWritePortBufferUshort(), ScsiPortWritePortUchar(), ScsiPortWritePortUlong(), ScsiPortWritePortUshort(), SetUpListener(), START_TEST(), StorPortReadPortBufferUchar(), StorPortReadPortBufferUlong(), StorPortReadPortBufferUshort(), StorPortReadPortUchar(), StorPortReadPortUlong(), StorPortReadPortUshort(), StorPortWritePortBufferUchar(), StorPortWritePortBufferUlong(), StorPortWritePortBufferUshort(), StorPortWritePortUchar(), StorPortWritePortUlong(), StorPortWritePortUshort(), TCPFreePort(), TdiOpenTransport(), TdiReceiveDatagram(), TdiSendDatagram(), TestWin2003ObjectTypes(), TryConnectPort(), TryCreatePort(), Uart16550GetByte(), Uart16550Initialize(), Uart16550PutByte(), Uart16550SetBaud(), UDPFreePort(), UhciPollController(), UhciRHClearFeaturePortConnectChange(), UhciRHClearFeaturePortEnable(), UhciRHClearFeaturePortEnableChange(), UhciRHClearFeaturePortOvercurrentChange(), UhciRHClearFeaturePortPower(), UhciRHClearFeaturePortResetChange(), UhciRHClearFeaturePortSuspend(), UhciRHClearFeaturePortSuspendChange(), UhciRHGetPortStatus(), UhciRHPortEnable(), UhciRHPortResetComplete(), UhciRHSetFeaturePortEnable(), UhciRHSetFeaturePortPower(), UhciRHSetFeaturePortReset(), UhciRHSetFeaturePortResetWorker(), UhciRHSetFeaturePortSuspend(), UhciStartController(), UnregisterIoPort(), USBD_CreateDeviceEx(), USBH_ChangeIndication(), USBH_ChangeIndicationAckChange(), USBH_ChangeIndicationAckChangeComplete(), USBH_ChangeIndicationQueryChange(), USBH_ChangeIndicationWorker(), USBH_CheckDeviceIDUnique(), USBH_CheckHubIdle(), USBH_CheckIdleAbort(), USBH_CreateDevice(), USBH_FdoCleanup(), USBH_FdoIdleNotificationCallback(), USBH_FdoPower(), USBH_FdoQueryBusRelations(), USBH_FdoSurpriseRemoveDevice(), USBH_FlushPortPwrList(), USBH_HubQueuePortIdleIrps(), USBH_HubQueuePortWakeIrps(), USBH_PdoRemoveDevice(), USBH_ProcessPortStateChange(), USBH_ResetDevice(), USBH_ResetPortWorker(), USBH_StartHubFdoDevice(), USBH_SyncClearPortStatus(), USBH_SyncDisablePort(), USBH_SyncGetPortStatus(), USBH_SyncPowerOnPort(), USBH_SyncPowerOnPorts(), USBH_SyncResetPort(), USBPORT_CreateDevice(), USBPORT_RH_SetFeatureUSB2PortPower(), USBPORT_RootHubClassCommand(), USBPORT_RootHubPowerAndChirpAllCcPorts(), USBPORT_RootHubSCE(), ValidatePort(), VgaInterpretCmdStream(), VgaReadPort(), VgaWritePort(), WaitForReady(), WinLdrEnableFifo(), WinLdrPortGetByte(), WinLdrPortInitialize(), WinLdrPortPollOnly(), WinLdrPortPutByte(), WRITE_GDC_CSRFORM(), WRITE_GDC_CSRW(), WRITE_GDC_PITCH(), WRITE_GDC_PRAM(), WRITE_GDC_SYNC(), WRITE_GDC_ZOOM(), WRITE_PORT_BUFFER_UCHAR(), WRITE_PORT_BUFFER_ULONG(), WRITE_PORT_BUFFER_USHORT(), WRITE_PORT_UCHAR(), WRITE_PORT_ULONG(), WRITE_PORT_USHORT(), WSAAsyncGetServByPort(), x86IoRead(), x86IoWrite(), and CMiniportWaveStreamCMI::~CMiniportWaveStreamCMI().

WinLdrTerminalConnected

BOOLEAN WinLdrTerminalConnected

Definition at line 34 of file headless.c.

Referenced by WinLdrInitializeHeadlessPort(), and WinLdrInitializePhase1().

WinLdrTerminalDelay

ULONG WinLdrTerminalDelay

Definition at line 36 of file headless.c.

Referenced by WinLdrInitializeHeadlessPort().

WinLdrTerminalDeviceId

ULONG WinLdrTerminalDeviceId

Definition at line 35 of file headless.c.

Referenced by WinLdrInitializeHeadlessPort().