inbv.h File Reference

#include "bootvid/bootvid.h"

Include dependency graph for inbv.h:

Go to the source code of this file.

Functions
BOOLEAN NTAPI	InbvDriverInitialize (_In_ PLOADER_PARAMETER_BLOCK LoaderBlock, _In_ ULONG Count)
INBV_DISPLAY_STATE NTAPI	InbvGetDisplayState (VOID)
VOID NTAPI	InbvAcquireLock (VOID)
VOID NTAPI	InbvReleaseLock (VOID)
PUCHAR NTAPI	InbvGetResourceAddress (_In_ ULONG ResourceNumber)
VOID NTAPI	InbvBitBlt (_In_ PUCHAR Buffer, _In_ ULONG X, _In_ ULONG Y)
VOID NTAPI	InbvBufferToScreenBlt (_In_ PUCHAR Buffer, _In_ ULONG X, _In_ ULONG Y, _In_ ULONG Width, _In_ ULONG Height, _In_ ULONG Delta)
VOID NTAPI	InbvScreenToBufferBlt (_Out_ PUCHAR Buffer, _In_ ULONG X, _In_ ULONG Y, _In_ ULONG Width, _In_ ULONG Height, _In_ ULONG Delta)
VOID NTAPI	InbvSetProgressBarCoordinates (_In_ ULONG Left, _In_ ULONG Top)
	Sets the screen coordinates of the loading progress bar and enable it. More...
VOID NTAPI	InbvIndicateProgress (VOID)
	Gives some progress feedback, without specifying any explicit number of progress steps or percentage. The corresponding percentage is derived from the progress indicator's current count, capped to the number of expected calls to be made to this function (default: 25, see InbvProgressIndicator.Expected). More...
VOID NTAPI	InbvSetProgressBarSubset (_In_ ULONG Floor, _In_ ULONG Ceiling)
	Specifies a progress percentage sub-range. Further calls to InbvIndicateProgress() or InbvUpdateProgressBar() will update the progress percentage relative to this sub-range. In particular, the percentage provided to InbvUpdateProgressBar() is relative to this sub-range. More...
VOID NTAPI	InbvUpdateProgressBar (_In_ ULONG Percentage)
	Updates the progress bar percentage, relative to the current percentage sub-range previously set by InbvSetProgressBarSubset(). More...
VOID NTAPI	InbvPortEnableFifo (IN ULONG PortId, IN BOOLEAN Enable)
BOOLEAN NTAPI	InbvPortPollOnly (IN ULONG PortId)
BOOLEAN NTAPI	InbvPortGetByte (IN ULONG PortId, OUT PUCHAR Byte)
VOID NTAPI	InbvPortPutByte (IN ULONG PortId, IN UCHAR Byte)
VOID NTAPI	InbvPortTerminate (IN ULONG PortId)
BOOLEAN NTAPI	InbvPortInitialize (IN ULONG BaudRate, IN ULONG PortNumber, IN PUCHAR PortAddress, OUT PULONG PortId, IN BOOLEAN IsMMIODevice)

Variables
BOOLEAN	InbvBootDriverInstalled

Function Documentation

InbvAcquireLock()

VOID NTAPI InbvAcquireLock

(

VOID

)

Definition at line 219 of file inbv.c.

{
    KIRQL OldIrql;

    /* Check if we're at dispatch level or lower */
    OldIrql = KeGetCurrentIrql();
    if (OldIrql <= DISPATCH_LEVEL)
    {
        /* Loop until the lock is free */
        while (!KeTestSpinLock(&BootDriverLock));

        /* Raise IRQL to dispatch level */
        KeRaiseIrql(DISPATCH_LEVEL, &OldIrql);
    }

    /* Acquire the lock */
    KiAcquireSpinLock(&BootDriverLock);
    InbvOldIrql = OldIrql;
}

Referenced by BootAnimTickProgressBar(), BootLogoFadeIn(), DisplayBootBitmap(), FinalizeBootLogo(), InbvBitBlt(), InbvDisplayString(), InbvEnableBootDriver(), InbvNotifyDisplayOwnershipLost(), InbvRotationThread(), and InbvSolidColorFill().

InbvBitBlt()

VOID NTAPI InbvBitBlt	(	_In_ PUCHAR	Buffer,
		_In_ ULONG	X,
		_In_ ULONG	Y
	)

Definition at line 530 of file inbv.c.

{
    /* Check if we're installed and we own it */
    if (InbvBootDriverInstalled &&
        (InbvDisplayState == INBV_DISPLAY_STATE_OWNED))
    {
        /* Acquire the lock */
        InbvAcquireLock();

        /* Do the blit */
        VidBitBlt(Buffer, X, Y);

        /* Release the lock */
        InbvReleaseLock();
    }
}

Referenced by BitBltPalette(), and PopShutdownHandler().

InbvBufferToScreenBlt()

VOID NTAPI InbvBufferToScreenBlt	(	_In_ PUCHAR	Buffer,
		_In_ ULONG	X,
		_In_ ULONG	Y,
		_In_ ULONG	Width,
		_In_ ULONG	Height,
		_In_ ULONG	Delta
	)

Definition at line 552 of file inbv.c.

{
    /* Check if we're installed and we own it */
    if (InbvBootDriverInstalled &&
        (InbvDisplayState == INBV_DISPLAY_STATE_OWNED))
    {
        /* Do the blit */
        VidBufferToScreenBlt(Buffer, X, Y, Width, Height, Delta);
    }
}

Referenced by DisplayBootBitmap().

InbvDriverInitialize()

BOOLEAN NTAPI InbvDriverInitialize	(	_In_ PLOADER_PARAMETER_BLOCK	LoaderBlock,
		_In_ ULONG	Count
	)

Definition at line 175 of file inbv.c.

{
    PCHAR CommandLine;
    BOOLEAN ResetMode = FALSE; // By default do not reset the video mode
    ULONG i;

    /* Quit if we're already installed */
    if (InbvBootDriverInstalled) return TRUE;

    /* Initialize the lock and check the current display state */
    KeInitializeSpinLock(&BootDriverLock);
    if (InbvDisplayState == INBV_DISPLAY_STATE_OWNED)
    {
        /* Reset the video mode in case we do not have a custom boot logo */
        CommandLine = (LoaderBlock->LoadOptions ? _strupr(LoaderBlock->LoadOptions) : NULL);
        ResetMode   = (CommandLine == NULL) || (strstr(CommandLine, "BOOTLOGO") == NULL);
    }

    /* Initialize the video */
    InbvBootDriverInstalled = VidInitialize(ResetMode);
    if (InbvBootDriverInstalled)
    {
        /* Find bitmap resources in the kernel */
        ResourceCount = min(Count, RTL_NUMBER_OF(ResourceList) - 1);
        for (i = 1; i <= ResourceCount; i++)
        {
            /* Do the lookup */
            ResourceList[i] = FindBitmapResource(LoaderBlock, i);
        }

        /* Set the progress bar ranges */
        InbvSetProgressBarSubset(0, 100);

        // BootAnimInitialize(LoaderBlock, Count);
    }

    /* Return install state */
    return InbvBootDriverInstalled;
}

Referenced by Phase1InitializationDiscard().

InbvGetDisplayState()

INBV_DISPLAY_STATE NTAPI InbvGetDisplayState

(

VOID

)

Definition at line 323 of file inbv.c.

{
    /* Return the actual state */
    return InbvDisplayState;
}

Referenced by BootAnimTickProgressBar(), BootLogoFadeIn(), FinalizeBootLogo(), and InbvRotationThread().

InbvGetResourceAddress()

PUCHAR NTAPI InbvGetResourceAddress

(

_In_ ULONG

ResourceNumber

)

Definition at line 162 of file inbv.c.

{
    /* Validate the resource number */
    if (ResourceNumber > ResourceCount) return NULL;

    /* Return the address */
    return ResourceList[ResourceNumber];
}

Referenced by DisplayBootBitmap(), and PopShutdownHandler().

InbvIndicateProgress()

VOID NTAPI InbvIndicateProgress

(

VOID

)

Gives some progress feedback, without specifying any explicit number of progress steps or percentage. The corresponding percentage is derived from the progress indicator's current count, capped to the number of expected calls to be made to this function (default: 25, see InbvProgressIndicator.Expected).

Returns

None.

Definition at line 625 of file inbv.c.

{
    ULONG Percentage;

    /* Increase progress */
    InbvProgressIndicator.Count++;

    /* Compute the new percentage - Don't go over 100% */
    Percentage = 100 * InbvProgressIndicator.Count /
                       InbvProgressIndicator.Expected;
    Percentage = min(Percentage, 99);

    if (Percentage != InbvProgressIndicator.Percentage)
    {
        /* Percentage has changed, update the progress bar */
        InbvProgressIndicator.Percentage = Percentage;
        InbvUpdateProgressBar(Percentage);
    }
}

Referenced by IopInitializeBuiltinDriver(), and IopInitializeSystemDrivers().

InbvPortEnableFifo()

VOID NTAPI InbvPortEnableFifo	(	IN ULONG	PortId,
		IN BOOLEAN	Enable
	)

Definition at line 56 of file inbvport.c.

{
    /* Set FIFO as requested */
    CpEnableFifo(Port[PortId].Address, Enable);
}

Referenced by HdlspEnableTerminal().

InbvPortGetByte()

BOOLEAN NTAPI InbvPortGetByte	(	IN ULONG	PortId,
		OUT PUCHAR	Byte
	)

Definition at line 38 of file inbvport.c.

{
    /* Read a byte from the port */
    return CpGetByte(&Port[PortId], Byte, TRUE, FALSE) == CP_GET_SUCCESS;
}

Referenced by HdlspDispatch().

InbvPortInitialize()

BOOLEAN NTAPI InbvPortInitialize	(	IN ULONG	BaudRate,
		IN ULONG	PortNumber,
		IN PUCHAR	PortAddress,
		OUT PULONG	PortId,
		IN BOOLEAN	IsMMIODevice
	)

Definition at line 73 of file inbvport.c.

{
    /* Not yet supported */
    ASSERT(IsMMIODevice == FALSE);

#if defined(SARCH_PC98)
    /* Set default baud rate */
    if (BaudRate == 0) BaudRate = 9600;

    /* Check if port or address given */
    if (PortNumber)
    {
        /* Pick correct address for port */
        if (!PortAddress)
        {
            if (PortNumber == 1)
            {
                PortAddress = (PUCHAR)0x30;
            }
            else
            {
                PortAddress = (PUCHAR)0x238;
                PortNumber = 2;
            }
        }
    }
    else
    {
        /* Pick correct port for address */
        PortAddress = (PUCHAR)0x30;
        if (CpDoesPortExist(PortAddress))
        {
            PortNumber = 1;
        }
        else
        {
            PortAddress = (PUCHAR)0x238;
            if (!CpDoesPortExist(PortAddress))
                return FALSE;

            PortNumber = 2;
        }
    }
#else
    /* Set default baud rate */
    if (BaudRate == 0) BaudRate = 19200;

    /* Check if port or address given */
    if (PortNumber)
    {
        /* Pick correct address for port */
        if (!PortAddress)
        {
            switch (PortNumber)
            {
                case 1:
                    PortAddress = (PUCHAR)0x3F8;
                    break;

                case 2:
                    PortAddress = (PUCHAR)0x2F8;
                    break;

                case 3:
                    PortAddress = (PUCHAR)0x3E8;
                    break;

                default:
                    PortNumber = 4;
                    PortAddress = (PUCHAR)0x2E8;
            }
        }
    }
    else
    {
        /* Pick correct port for address */
        PortAddress = (PUCHAR)0x2F8;
        if (CpDoesPortExist(PortAddress))
        {
            PortNumber = 2;
        }
        else
        {
            PortAddress = (PUCHAR)0x3F8;
            if (!CpDoesPortExist(PortAddress)) return FALSE;
            PortNumber = 1;
        }
    }
#endif

    /* Initialize the port unless it's already up, and then return it */
    if (Port[PortNumber - 1].Address) return FALSE;

    CpInitialize(&Port[PortNumber - 1], PortAddress, BaudRate);
    *PortId = PortNumber - 1;

    return TRUE;
}

Referenced by HdlspEnableTerminal().

InbvPortPollOnly()

BOOLEAN NTAPI InbvPortPollOnly

(

IN ULONG

PortId

)

Definition at line 28 of file inbvport.c.

{
    UCHAR Dummy;

    /* Poll a byte from the port */
    return CpGetByte(&Port[PortId], &Dummy, FALSE, TRUE) == CP_GET_SUCCESS;
}

Referenced by HdlspDispatch().

InbvPortPutByte()

VOID NTAPI InbvPortPutByte	(	IN ULONG	PortId,
		IN UCHAR	Byte
	)

Definition at line 47 of file inbvport.c.

{
    /* Send the byte */
    CpPutByte(&Port[PortId], Byte);
}

Referenced by HdlspPutData(), and HdlspSendStringAtBaud().

InbvPortTerminate()

VOID NTAPI InbvPortTerminate

(

IN ULONG

PortId

)

Definition at line 65 of file inbvport.c.

{
    /* The port is now available */
    Port[PortId].Address = NULL;
}

Referenced by HdlspEnableTerminal().

InbvReleaseLock()

VOID NTAPI InbvReleaseLock

(

VOID

)

Definition at line 241 of file inbv.c.

{
    KIRQL OldIrql;

    /* Capture the old IRQL */
    OldIrql = InbvOldIrql;

    /* Release the driver lock */
    KiReleaseSpinLock(&BootDriverLock);

    /* If we were at dispatch level or lower, restore the old IRQL */
    if (InbvOldIrql <= DISPATCH_LEVEL) KeLowerIrql(OldIrql);
}

Referenced by BootAnimTickProgressBar(), BootLogoFadeIn(), DisplayBootBitmap(), FinalizeBootLogo(), InbvBitBlt(), InbvDisplayString(), InbvEnableBootDriver(), InbvNotifyDisplayOwnershipLost(), InbvRotationThread(), and InbvSolidColorFill().

InbvScreenToBufferBlt()

VOID NTAPI InbvScreenToBufferBlt	(	_Out_ PUCHAR	Buffer,
		_In_ ULONG	X,
		_In_ ULONG	Y,
		_In_ ULONG	Width,
		_In_ ULONG	Height,
		_In_ ULONG	Delta
	)

Definition at line 571 of file inbv.c.

{
    /* Check if we're installed and we own it */
    if (InbvBootDriverInstalled &&
        (InbvDisplayState == INBV_DISPLAY_STATE_OWNED))
    {
        /* Do the blit */
        VidScreenToBufferBlt(Buffer, X, Y, Width, Height, Delta);
    }
}

Referenced by DisplayBootBitmap().

InbvSetProgressBarCoordinates()

VOID NTAPI InbvSetProgressBarCoordinates	(	_In_ ULONG	Left,
		_In_ ULONG	Top
	)

Sets the screen coordinates of the loading progress bar and enable it.

Parameters

[in]	Left
[in]	Top	The left/top coordinates.

Returns

None.

Definition at line 600 of file inbv.c.

{
    /* Update the coordinates */
    ProgressBarLeft = Left;
    ProgressBarTop  = Top;

    /* Enable the progress bar */
    ShowProgressBar = TRUE;
}

Referenced by DisplayBootBitmap().

InbvSetProgressBarSubset()

VOID NTAPI InbvSetProgressBarSubset	(	_In_ ULONG	Floor,
		_In_ ULONG	Ceiling
	)

Specifies a progress percentage sub-range. Further calls to InbvIndicateProgress() or InbvUpdateProgressBar() will update the progress percentage relative to this sub-range. In particular, the percentage provided to InbvUpdateProgressBar() is relative to this sub-range.

Parameters

[in]	Floor	The lower bound percentage of the sub-range (default: 0).
[in]	Ceiling	The upper bound percentage of the sub-range (default: 100).

Returns

None.

Definition at line 663 of file inbv.c.

{
    /* Sanity checks */
    ASSERT(Floor < Ceiling);
    ASSERT(Ceiling <= 100);

    /* Update the progress bar state */
    InbvProgressState.Floor = Floor * 100;
    InbvProgressState.Ceiling = Ceiling * 100;
    InbvProgressState.Bias = Ceiling - Floor;
}

Referenced by BootAnimInitialize(), InbvDriverInitialize(), and Phase1InitializationDiscard().

InbvUpdateProgressBar()

VOID NTAPI InbvUpdateProgressBar

(

_In_ ULONG

Percentage

)

Updates the progress bar percentage, relative to the current percentage sub-range previously set by InbvSetProgressBarSubset().

Parameters

[in]

Percentage

The progress percentage, relative to the current sub-range.

Returns

None.

Definition at line 689 of file inbv.c.

{
    ULONG TotalProgress;

    /* Make sure the progress bar is enabled, that we own and are installed */
    if (ShowProgressBar &&
        InbvBootDriverInstalled &&
        (InbvDisplayState == INBV_DISPLAY_STATE_OWNED))
    {
        /* Compute the total progress and tick the progress bar */
        TotalProgress = InbvProgressState.Floor + (Percentage * InbvProgressState.Bias);
        // TotalProgress /= (100 * 100);

        BootAnimTickProgressBar(TotalProgress);
    }
}

Referenced by InbvIndicateProgress(), and Phase1InitializationDiscard().

Variable Documentation

InbvBootDriverInstalled

BOOLEAN InbvBootDriverInstalled

Definition at line 39 of file inbv.c.

Referenced by BootAnimInitialize(), BootAnimTickProgressBar(), BootLogoFadeIn(), DisplayBootBitmap(), InbvBitBlt(), InbvBufferToScreenBlt(), InbvDisplayString(), InbvDriverInitialize(), InbvEnableBootDriver(), InbvIsBootDriverInstalled(), InbvNotifyDisplayOwnershipLost(), InbvResetDisplay(), InbvScreenToBufferBlt(), InbvSolidColorFill(), InbvUpdateProgressBar(), and Phase1InitializationDiscard().