kd.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_KDP_DEBUG_MODE
struct	_KD_DISPATCH_TABLE

Macros
#define	DEFAULT_DEBUG_PORT   2 /* COM2 */
#define	DEFAULT_DEBUG_COM1_IRQ   4 /* COM1 IRQ */
#define	DEFAULT_DEBUG_COM2_IRQ   3 /* COM2 IRQ */
#define	DEFAULT_DEBUG_BAUD_RATE   115200 /* 115200 Baud */
#define	KdScreen   0
#define	KdSerial   1
#define	KdFile   2
#define	KdKdbg   3
#define	KdMax   4

Typedefs
typedef NTSTATUS(NTAPI *	PKDP_INIT_ROUTINE) (_In_ struct _KD_DISPATCH_TABLE *DispatchTable, _In_ ULONG BootPhase)
typedef VOID(NTAPI *	PKDP_PRINT_ROUTINE) (_In_ PCCH String, _In_ ULONG Length)
typedef struct _KDP_DEBUG_MODE	KDP_DEBUG_MODE
typedef struct _KD_DISPATCH_TABLE	KD_DISPATCH_TABLE
typedef struct _KD_DISPATCH_TABLE *	PKD_DISPATCH_TABLE

Functions
VOID	KdIoPuts (_In_ PCSTR String)
VOID __cdecl	KdIoPrintf (_In_ PCSTR Format,...)
SIZE_T	KdIoReadLine (_Out_ PCHAR Buffer, _In_ SIZE_T Size)
	Reads a line of user input from the terminal.
KIRQL NTAPI	KdbpAcquireLock (_In_ PKSPIN_LOCK SpinLock)
VOID NTAPI	KdbpReleaseLock (_In_ PKSPIN_LOCK SpinLock, _In_ KIRQL OldIrql)
VOID	KdpScreenAcquire (VOID)
VOID	KdpScreenRelease (VOID)
NTSTATUS NTAPI	KdpScreenInit (_In_ struct _KD_DISPATCH_TABLE *DispatchTable, _In_ ULONG BootPhase)
NTSTATUS NTAPI	KdpSerialInit (_In_ struct _KD_DISPATCH_TABLE *DispatchTable, _In_ ULONG BootPhase)
NTSTATUS NTAPI	KdpDebugLogInit (_In_ struct _KD_DISPATCH_TABLE *DispatchTable, _In_ ULONG BootPhase)

Variables
KDP_DEBUG_MODE	KdpDebugMode
ULONG	SerialPortNumber
CPPORT	SerialPortInfo
ANSI_STRING	KdpLogFileName
PKDP_INIT_ROUTINE	InitRoutines [KdMax]
KD_DISPATCH_TABLE	DispatchTable [KdMax]
LIST_ENTRY	KdProviders

Macro Definition Documentation

DEFAULT_DEBUG_BAUD_RATE

#define DEFAULT_DEBUG_BAUD_RATE   115200 /* 115200 Baud */

Definition at line 83 of file kd.h.

DEFAULT_DEBUG_COM1_IRQ

#define DEFAULT_DEBUG_COM1_IRQ   4 /* COM1 IRQ */

Definition at line 81 of file kd.h.

DEFAULT_DEBUG_COM2_IRQ

#define DEFAULT_DEBUG_COM2_IRQ   3 /* COM2 IRQ */

Definition at line 82 of file kd.h.

DEFAULT_DEBUG_PORT

#define DEFAULT_DEBUG_PORT   2 /* COM2 */

Definition at line 80 of file kd.h.

KdFile

#define KdFile   2

Definition at line 88 of file kd.h.

KdKdbg

#define KdKdbg   3

Definition at line 89 of file kd.h.

KdMax

#define KdMax   4

Definition at line 90 of file kd.h.

KdScreen

#define KdScreen   0

Definition at line 86 of file kd.h.

KdSerial

#define KdSerial   1

Definition at line 87 of file kd.h.

Typedef Documentation

KD_DISPATCH_TABLE

typedef struct _KD_DISPATCH_TABLE KD_DISPATCH_TABLE

KDP_DEBUG_MODE

typedef struct _KDP_DEBUG_MODE KDP_DEBUG_MODE

PKD_DISPATCH_TABLE

typedef struct _KD_DISPATCH_TABLE * PKD_DISPATCH_TABLE

PKDP_INIT_ROUTINE

typedef NTSTATUS(NTAPI * PKDP_INIT_ROUTINE) (_In_ struct _KD_DISPATCH_TABLE *DispatchTable, _In_ ULONG BootPhase)

Definition at line 8 of file kd.h.

PKDP_PRINT_ROUTINE

typedef VOID(NTAPI * PKDP_PRINT_ROUTINE) (_In_ PCCH String, _In_ ULONG Length)

Definition at line 14 of file kd.h.

Function Documentation

KdbpAcquireLock()

KIRQL NTAPI KdbpAcquireLock

(

_In_ PKSPIN_LOCK

SpinLock

)

Definition at line 64 of file kdio.c.

{
    KIRQL OldIrql;
 
    /* Acquire the spinlock without waiting at raised IRQL */
    while (TRUE)
    {
        /* Loop until the spinlock becomes available */
        while (!KeTestSpinLock(SpinLock));
 
        /* Spinlock is free, raise IRQL to high level */
        KeRaiseIrql(HIGH_LEVEL, &OldIrql);
 
        /* Try to get the spinlock */
        if (KeTryToAcquireSpinLockAtDpcLevel(SpinLock))
            break;
 
        /* Someone else got the spinlock, lower IRQL back */
        KeLowerIrql(OldIrql);
    }
 
    return OldIrql;
}

Referenced by KdbDebugPrint(), KdpPrintToLogFile(), and KdpSerialPrint().

KdbpReleaseLock()

VOID NTAPI KdbpReleaseLock	(	_In_ PKSPIN_LOCK	SpinLock,
		_In_ KIRQL	OldIrql
	)

Definition at line 91 of file kdio.c.

{
    /* Release the spinlock */
    KiReleaseSpinLock(SpinLock);
    // KeReleaseSpinLockFromDpcLevel(SpinLock);
 
    /* Restore the old IRQL */
    KeLowerIrql(OldIrql);
}

Referenced by KdbDebugPrint(), KdpPrintToLogFile(), and KdpSerialPrint().

KdIoPrintf()

VOID __cdecl KdIoPrintf	(	_In_ PCSTR	Format,
			...
	)

Definition at line 576 of file kdio.c.

{
    va_list ap;
    ULONG Length;
    CHAR Buffer[512];
 
    /* Format the string */
    va_start(ap, Format);
    Length = (ULONG)_vsnprintf(Buffer,
                               sizeof(Buffer),
                               Format,
                               ap);
    va_end(ap);
 
    /* Send it to the display providers */
    KdIoPrintString(Buffer, Length);
}

Referenced by KdIoReadLine(), KdReceivePacket(), and KdSendPacket().

KdIoPuts()

VOID KdIoPuts

(

_In_ PCSTR

String

)

Definition at line 568 of file kdio.c.

{
    KdIoPrintString(String, (ULONG)strlen(String));
}

Referenced by KdIoReadLine(), and KdReceivePacket().

KdIoReadLine()

SIZE_T KdIoReadLine	(	_Out_ PCHAR	Buffer,
		_In_ SIZE_T	Size
	)

Reads a line of user input from the terminal.

Parameters

[out]	Buffer	Buffer where to store the input. Trailing newlines are removed.
[in]	Size	Size of Buffer.

Returns

Returns the number of characters stored, not counting the NULL terminator.

Note

Accepts only
newlines, \r is ignored.

Definition at line 51 of file kdprompt.c.

{
    PCHAR Orig = Buffer;
    ULONG ScanCode = 0;
    CHAR Key;
    BOOLEAN EchoOn = !(KdbDebugState & KD_DEBUG_KDNOECHO);
    LONG CmdHistIndex = -1; // Start at end of history.
 
    /* Flush the input buffer */
    KdpFlushTerminalInput();
 
    /* Bail out if the buffer is zero-sized */
    if (Size == 0)
        return 0;
 
    for (;;)
    {
        Key = KdpReadTermKey(&ScanCode);
 
        /* Check for return or newline */
        if ((Key == '\r') || (Key == '\n'))
        {
            *Buffer = ANSI_NULL;
            KdIoPuts("\n");
            return (SIZE_T)(Buffer - Orig);
        }
        else if (Key == KEY_BS || Key == KEY_DEL)
        {
            /* Erase the last character */
            if (Buffer > Orig)
            {
                Buffer--;
                *Buffer = ANSI_NULL;
 
                if (EchoOn)
                    KdIoPrintf("%c %c", KEY_BS, KEY_BS);
                else
                    KdIoPrintf(" %c", KEY_BS);
            }
        }
        else if (ScanCode == KEY_SCAN_UP || ScanCode == KEY_SCAN_DOWN)
        {
            PCSTR CmdHistory = KdbGetHistoryEntry(&CmdHistIndex,
                                                  (ScanCode == KEY_SCAN_DOWN));
            if (CmdHistory)
            {
                SIZE_T i;
 
                /* Erase the whole line */
                while (Buffer > Orig)
                {
                    Buffer--;
                    *Buffer = ANSI_NULL;
 
                    if (EchoOn)
                        KdIoPrintf("%c %c", KEY_BS, KEY_BS);
                    else
                        KdIoPrintf(" %c", KEY_BS);
                }
 
                /* Copy and display the history entry */
                i = min(strlen(CmdHistory), Size - 1);
                memcpy(Orig, CmdHistory, i);
                Orig[i] = ANSI_NULL;
                Buffer = Orig + i;
                KdIoPuts(Orig);
            }
        }
        else
        {
            /* Do not accept characters anymore if the buffer is full */
            if ((SIZE_T)(Buffer - Orig) >= (Size - 1))
                continue;
 
            if (EchoOn)
                KdIoPrintf("%c", Key);
 
            *Buffer = Key;
            Buffer++;
        }
    }
}

Referenced by KdReceivePacket().

KdpDebugLogInit()

NTSTATUS NTAPI KdpDebugLogInit	(	_In_ struct _KD_DISPATCH_TABLE *	DispatchTable,
		_In_ ULONG	BootPhase
	)

KdpScreenAcquire()

VOID KdpScreenAcquire

(

VOID

)

Definition at line 431 of file kdio.c.

{
    if (InbvIsBootDriverInstalled() /* &&
        !InbvCheckDisplayOwnership() */)
    {
        /* Acquire ownership and reset the display */
        InbvAcquireDisplayOwnership();
        InbvResetDisplay();
        InbvSolidColorFill(0, 0, SCREEN_WIDTH - 1, SCREEN_HEIGHT - 1, BV_COLOR_BLACK);
        InbvSetTextColor(BV_COLOR_WHITE);
        InbvInstallDisplayStringFilter(NULL);
        InbvEnableDisplayString(TRUE);
        InbvSetScrollRegion(0, 0, SCREEN_WIDTH - 1, SCREEN_HEIGHT - 1);
    }
}

Referenced by KdbpInternalEnter(), and KdpScreenInit().

KdpScreenInit()

NTSTATUS NTAPI KdpScreenInit	(	_In_ struct _KD_DISPATCH_TABLE *	DispatchTable,
		_In_ ULONG	BootPhase
	)

KdpScreenRelease()

VOID KdpScreenRelease

(

VOID

)

Definition at line 450 of file kdio.c.

{
    if (InbvIsBootDriverInstalled()&&
        InbvCheckDisplayOwnership())
    {
        /* Release the display */
        // InbvSetDisplayOwnership(FALSE);
        InbvNotifyDisplayOwnershipLost(NULL);
    }
}

Referenced by KdbpInternalEnter().

KdpSerialInit()

NTSTATUS NTAPI KdpSerialInit	(	_In_ struct _KD_DISPATCH_TABLE *	DispatchTable,
		_In_ ULONG	BootPhase
	)

Variable Documentation

DispatchTable

KD_DISPATCH_TABLE DispatchTable[KdMax]

extern

Definition at line 17 of file global.c.

InitRoutines

PKDP_INIT_ROUTINE InitRoutines[KdMax]

extern

Definition at line 50 of file kdio.c.

Referenced by KdDebuggerInitialize0().

KdpDebugMode

KDP_DEBUG_MODE KdpDebugMode

extern

Definition at line 46 of file kdio.c.

Referenced by KdbpInternalEnter(), KdDebuggerInitialize0(), KdpDebugLogInit(), KdpGetDebugMode(), KdpGetTerminalSettings(), KdpInitTerminal(), KdpScreenInit(), KdpSerialInit(), KdpUpdateTerminalSize(), and KdSendPacket().

KdpLogFileName

ANSI_STRING KdpLogFileName

extern

Definition at line 36 of file kdio.c.

Referenced by KdpDebugLogInit(), and KdpGetDebugMode().

KdProviders

LIST_ENTRY KdProviders

extern

Definition at line 47 of file kdio.c.

Referenced by KdbInitialize(), KdDebuggerInitialize1(), KdIoPrintString(), KdpDebugLogInit(), KdpDriverReinit(), KdpScreenInit(), and KdpSerialInit().

SerialPortInfo

CPPORT SerialPortInfo

extern

Definition at line 40 of file kdio.c.

Referenced by KdbpSendCommandSerial(), KdbpTryGetCharSerial(), KdpGetDebugMode(), KdpSerialInit(), and KdpSerialPrint().

SerialPortNumber

ULONG SerialPortNumber

extern

Definition at line 39 of file kdio.c.

Referenced by KdpGetDebugMode(), and KdpSerialInit().