kddll.h File Reference

#include <ntifs.h>
#include <windbgkd.h>

Include dependency graph for kddll.h:

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

Go to the source code of this file.

Macros
#define	NOEXTAPI
#define	KDDBGPRINT(...)

Enumerations
enum	KDP_STATUS {   KDP_PACKET_RECEIVED = 0, KDP_PACKET_TIMEOUT = 1, KDP_PACKET_RESEND = 2, KDP_PACKET_RECEIVED = 0,   KDP_PACKET_TIMEOUT = 1, KDP_PACKET_RESEND = 2 }

Functions
VOID NTAPI	KdpSendBuffer (IN PVOID Buffer, IN ULONG Size)
KDP_STATUS NTAPI	KdpReceiveBuffer (OUT PVOID Buffer, IN ULONG Size)
KDP_STATUS NTAPI	KdpReceivePacketLeader (OUT PULONG PacketLeader)
VOID NTAPI	KdpSendByte (IN UCHAR Byte)
KDP_STATUS NTAPI	KdpPollByte (OUT PUCHAR OutByte)
KDP_STATUS NTAPI	KdpReceiveByte (OUT PUCHAR OutByte)
KDP_STATUS NTAPI	KdpPollBreakIn (VOID)

Macro Definition Documentation

KDDBGPRINT

#define KDDBGPRINT

(

...

)

Definition at line 19 of file kddll.h.

NOEXTAPI

#define NOEXTAPI

Definition at line 12 of file kddll.h.

Enumeration Type Documentation

KDP_STATUS

enum KDP_STATUS

Enumerator
KDP_PACKET_RECEIVED
KDP_PACKET_TIMEOUT
KDP_PACKET_RESEND
KDP_PACKET_RECEIVED
KDP_PACKET_TIMEOUT
KDP_PACKET_RESEND

Definition at line 25 of file kddll.h.

{
    KDP_PACKET_RECEIVED = 0,
    KDP_PACKET_TIMEOUT  = 1,
    KDP_PACKET_RESEND   = 2
} KDP_STATUS;

Function Documentation

KdpPollBreakIn()

KDP_STATUS NTAPI KdpPollBreakIn

(

VOID

)

Definition at line 343 of file kdcom.c.

{
    KDP_STATUS KdStatus;
    UCHAR Byte;

    KdStatus = KdpPollByte(&Byte);
    if ((KdStatus == KDP_PACKET_RECEIVED) && (Byte == BREAKIN_PACKET_BYTE))
    {
        return KDP_PACKET_RECEIVED;
    }
    return KDP_PACKET_TIMEOUT;
}

KdpPollByte()

KDP_STATUS NTAPI KdpPollByte

(

OUT PUCHAR

OutByte

)

Definition at line 299 of file kdcom.c.

{
    USHORT Status;

    /* Poll the byte */
    Status = CpGetByte(&KdComPort, OutByte, FALSE, FALSE);
    switch (Status)
    {
        case CP_GET_SUCCESS:
            return KDP_PACKET_RECEIVED;

        case CP_GET_NODATA:
            return KDP_PACKET_TIMEOUT;

        case CP_GET_ERROR:
        default:
            return KDP_PACKET_RESEND;
    }
}

KdpReceiveBuffer()

KDP_STATUS NTAPI KdpReceiveBuffer	(	OUT PVOID	Buffer,
		IN ULONG	Size
	)

Definition at line 43 of file kdserial.c.

{
    PUCHAR ByteBuffer = Buffer;
    UCHAR Byte;
    KDP_STATUS Status;

    while (Size-- > 0)
    {
        /* Try to get a byte from the port */
        Status = KdpReceiveByte(&Byte);
        if (Status != KDP_PACKET_RECEIVED)
            return Status;

        *ByteBuffer++ = Byte;
    }

    return KDP_PACKET_RECEIVED;
}

Referenced by KdReceivePacket().

KdpReceiveByte()

KDP_STATUS NTAPI KdpReceiveByte

(

OUT PUCHAR

OutByte

)

Definition at line 321 of file kdcom.c.

{
    USHORT Status;

    /* Get the byte */
    Status = CpGetByte(&KdComPort, OutByte, TRUE, FALSE);
    switch (Status)
    {
        case CP_GET_SUCCESS:
            return KDP_PACKET_RECEIVED;

        case CP_GET_NODATA:
            return KDP_PACKET_TIMEOUT;

        case CP_GET_ERROR:
        default:
            return KDP_PACKET_RESEND;
    }
}

Referenced by finish_gdb_packet(), gdb_receive_packet(), KdpReceiveBuffer(), and KdpReceivePacketLeader().

KdpReceivePacketLeader()

KDP_STATUS NTAPI KdpReceivePacketLeader

(

OUT PULONG

PacketLeader

)

Definition at line 75 of file kdserial.c.

{
    UCHAR Index = 0, Byte, Buffer[4];
    KDP_STATUS KdStatus;

    /* Set first character to 0 */
    Buffer[0] = 0;

    do
    {
        /* Receive a single byte */
        KdStatus = KdpReceiveByte(&Byte);

        /* Check for timeout */
        if (KdStatus == KDP_PACKET_TIMEOUT)
        {
            /* Check if we already got a breakin byte */
            if (Buffer[0] == BREAKIN_PACKET_BYTE)
            {
                return KDP_PACKET_RESEND;
            }

            /* Report timeout */
            return KDP_PACKET_TIMEOUT;
        }

        /* Check if we received a byte */
        if (KdStatus == KDP_PACKET_RECEIVED)
        {
            /* Check if this is a valid packet leader byte */
            if (Byte == PACKET_LEADER_BYTE ||
                Byte == CONTROL_PACKET_LEADER_BYTE)
            {
                /* Check if we match the first byte */
                if (Byte != Buffer[0])
                {
                    /* No, this is the new byte 0! */
                    Index = 0;
                }

                /* Store the byte in the buffer */
                Buffer[Index] = Byte;

                /* Continue with next byte */
                Index++;
                continue;
            }

            /* Check for breakin byte */
            if (Byte == BREAKIN_PACKET_BYTE)
            {
                KDDBGPRINT("BREAKIN_PACKET_BYTE\n");
                Index = 0;
                Buffer[0] = Byte;
                continue;
            }
        }

        /* Restart */
        Index = 0;
        Buffer[0] = 0;
    }
    while (Index < 4);

    /* Enable the debugger */
    KD_DEBUGGER_NOT_PRESENT = FALSE;
    SharedUserData->KdDebuggerEnabled |= 0x00000002;

    /* Return the received packet leader */
    *PacketLeader = *(PULONG)Buffer;

    return KDP_PACKET_RECEIVED;
}

Referenced by KdReceivePacket().

KdpSendBuffer()

VOID NTAPI KdpSendBuffer	(	IN PVOID	Buffer,
		IN ULONG	Size
	)

Definition at line 21 of file kdserial.c.

{
    PUCHAR ByteBuffer = Buffer;

    while (Size-- > 0)
    {
        KdpSendByte(*ByteBuffer++);
    }
}

Referenced by KdpSendControlPacket(), and KdSendPacket().

KdpSendByte()

VOID NTAPI KdpSendByte

(

IN UCHAR

Byte

)

Definition at line 291 of file kdcom.c.

{
    /* Send the byte */
    CpPutByte(&KdComPort, Byte);
}

Referenced by finish_gdb_packet(), gdb_receive_packet(), KdpPollBreakIn(), KdpSendBuffer(), KdSendPacket(), send_gdb_partial_binary(), send_gdb_partial_packet(), and start_gdb_packet().