kdcom.c File Reference

#include "kdgdb.h"
#include <cportlib/cportlib.h>
#include <arc/arc.h>
#include <stdlib.h>
#include <ndk/halfuncs.h>

Include dependency graph for kdcom.c:

Go to the source code of this file.

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	DEFAULT_BAUD_RATE   19200
#define	MAX_COM_PORTS   (sizeof(BaseArray) / sizeof(BaseArray[0]) - 1)

Functions
NTSTATUS NTAPI	KdD0Transition (VOID)
NTSTATUS NTAPI	KdD3Transition (VOID)
NTSTATUS NTAPI	KdSave (IN BOOLEAN SleepTransition)
NTSTATUS NTAPI	KdRestore (IN BOOLEAN SleepTransition)
NTSTATUS NTAPI	KdpPortInitialize (IN ULONG ComPortNumber, IN ULONG ComPortBaudRate)
NTSTATUS NTAPI	KdDebuggerInitialize0 (IN PLOADER_PARAMETER_BLOCK LoaderBlock OPTIONAL)
NTSTATUS NTAPI	KdDebuggerInitialize1 (IN PLOADER_PARAMETER_BLOCK LoaderBlock OPTIONAL)
VOID NTAPI	KdpSendByte (_In_ UCHAR Byte)
KDSTATUS NTAPI	KdpPollByte (OUT PUCHAR OutByte)
KDSTATUS NTAPI	KdpReceiveByte (_Out_ PUCHAR OutByte)
KDSTATUS NTAPI	KdpPollBreakIn (VOID)

Variables
CPPORT	KdComPort
ULONG	KdComPortIrq = 0

Macro Definition Documentation

DEFAULT_BAUD_RATE

#define DEFAULT_BAUD_RATE   19200

Definition at line 21 of file kdcom.c.

DEFAULT_DEBUG_BAUD_RATE

#define DEFAULT_DEBUG_BAUD_RATE   115200 /* 115200 Baud */

Definition at line 19 of file kdcom.c.

DEFAULT_DEBUG_COM1_IRQ

#define DEFAULT_DEBUG_COM1_IRQ   4 /* COM1 IRQ */

Definition at line 17 of file kdcom.c.

DEFAULT_DEBUG_COM2_IRQ

#define DEFAULT_DEBUG_COM2_IRQ   3 /* COM2 IRQ */

Definition at line 18 of file kdcom.c.

DEFAULT_DEBUG_PORT

#define DEFAULT_DEBUG_PORT   2 /* COM2 */

Definition at line 16 of file kdcom.c.

MAX_COM_PORTS

#define MAX_COM_PORTS   (sizeof(BaseArray) / sizeof(BaseArray[0]) - 1)

Definition at line 39 of file kdcom.c.

Function Documentation

KdD0Transition()

NTSTATUS NTAPI KdD0Transition

(

VOID

)

Definition at line 90 of file kdcom.c.

{
    return STATUS_SUCCESS;
}

KdD3Transition()

NTSTATUS NTAPI KdD3Transition

(

VOID

)

Definition at line 97 of file kdcom.c.

{
    return STATUS_SUCCESS;
}

KdDebuggerInitialize0()

NTSTATUS NTAPI KdDebuggerInitialize0

(

IN PLOADER_PARAMETER_BLOCK LoaderBlock

OPTIONAL

)

Definition at line 145 of file kdcom.c.

{
    ULONG ComPortNumber   = DEFAULT_DEBUG_PORT;
    ULONG ComPortBaudRate = DEFAULT_DEBUG_BAUD_RATE;

    PCHAR CommandLine, PortString, BaudString, IrqString;
    ULONG Value;

    /* Check if we have a LoaderBlock */
    if (LoaderBlock)
    {
        /* Get the Command Line */
        CommandLine = LoaderBlock->LoadOptions;

        /* Upcase it */
        _strupr(CommandLine);

        /* Get the port and baud rate */
        PortString = strstr(CommandLine, "DEBUGPORT");
        BaudString = strstr(CommandLine, "BAUDRATE");
        IrqString  = strstr(CommandLine, "IRQ");

        /* Check if we got the /DEBUGPORT parameter */
        if (PortString)
        {
            /* Move past the actual string, to reach the port*/
            PortString += strlen("DEBUGPORT");

            /* Now get past any spaces and skip the equal sign */
            while (*PortString == ' ') PortString++;
            PortString++;

            /* Do we have a serial port? */
            if (strncmp(PortString, "COM", 3) != 0)
            {
                return STATUS_INVALID_PARAMETER;
            }

            /* Check for a valid Serial Port */
            PortString += 3;
            Value = atol(PortString);
            if (Value >= sizeof(BaseArray) / sizeof(BaseArray[0]))
            {
                return STATUS_INVALID_PARAMETER;
            }

            /* Set the port to use */
            ComPortNumber = Value;
       }

        /* Check if we got a baud rate */
        if (BaudString)
        {
            /* Move past the actual string, to reach the rate */
            BaudString += strlen("BAUDRATE");

            /* Now get past any spaces */
            while (*BaudString == ' ') BaudString++;

            /* And make sure we have a rate */
            if (*BaudString)
            {
                /* Read and set it */
                Value = atol(BaudString + 1);
                if (Value) ComPortBaudRate = Value;
            }
        }

        /* Check Serial Port Settings [IRQ] */
        if (IrqString)
        {
            /* Move past the actual string, to reach the rate */
            IrqString += strlen("IRQ");

            /* Now get past any spaces */
            while (*IrqString == ' ') IrqString++;

            /* And make sure we have an IRQ */
            if (*IrqString)
            {
                /* Read and set it */
                Value = atol(IrqString + 1);
                if (Value) KdComPortIrq = Value;
            }
        }
    }

#ifdef KDDEBUG
    /*
     * Try to find a free COM port and use it as the KD debugging port.
     * NOTE: Inspired by reactos/boot/freeldr/freeldr/comm/rs232.c, Rs232PortInitialize(...)
     */
    {
    /*
     * Start enumerating COM ports from the last one to the first one,
     * and break when we find a valid port.
     * If we reach the first element of the list, the invalid COM port,
     * then it means that no valid port was found.
     */
    ULONG ComPort;
    for (ComPort = MAX_COM_PORTS; ComPort > 0; ComPort--)
    {
        /* Check if the port exist; skip the KD port */
        if ((ComPort != ComPortNumber) && CpDoesPortExist(UlongToPtr(BaseArray[ComPort])))
            break;
    }
    if (ComPort != 0)
        CpInitialize(&KdDebugComPort, UlongToPtr(BaseArray[ComPort]), DEFAULT_BAUD_RATE);
    }
#endif

    /* Initialize the port */
    return KdpPortInitialize(ComPortNumber, ComPortBaudRate);
}

KdDebuggerInitialize1()

NTSTATUS NTAPI KdDebuggerInitialize1

(

IN PLOADER_PARAMETER_BLOCK LoaderBlock

OPTIONAL

)

Definition at line 268 of file kdcom.c.

{
    return STATUS_SUCCESS;
}

KdpPollBreakIn()

KDSTATUS NTAPI KdpPollBreakIn

(

VOID

)

Definition at line 319 of file kdcom.c.

{
    KDSTATUS KdStatus;
    UCHAR Byte;

    KdStatus = KdpPollByte(&Byte);
    if (KdStatus == KdPacketReceived)
    {
        if (Byte == 0x03)
        {
            KDDBGPRINT("BreakIn Polled.\n");
            return KdPacketReceived;
        }
        else if (Byte == '$')
        {
            /* GDB tried to send a new packet. N-ack it. */
            KdpSendByte('-');
        }
    }
    return KdPacketTimedOut;
}

KdpPollByte()

KDSTATUS NTAPI KdpPollByte

(

OUT PUCHAR

OutByte

)

Definition at line 284 of file kdcom.c.

{
    /* Poll the byte */
    if (CpGetByte(&KdComPort, OutByte, FALSE, FALSE) == CP_GET_SUCCESS)
    {
        return KdPacketReceived;
    }
    else
    {
        return KdPacketTimedOut;
    }
}

KdpPortInitialize()

NTSTATUS NTAPI KdpPortInitialize	(	IN ULONG	ComPortNumber,
		IN ULONG	ComPortBaudRate
	)

Definition at line 120 of file kdcom.c.

{
    NTSTATUS Status;

    Status = CpInitialize(&KdComPort,
                          UlongToPtr(BaseArray[ComPortNumber]),
                          ComPortBaudRate);
    if (!NT_SUCCESS(Status))
    {
        return STATUS_INVALID_PARAMETER;
    }

    KdComPortInUse = KdComPort.Address;
    return STATUS_SUCCESS;
}

KdpReceiveByte()

KDSTATUS NTAPI KdpReceiveByte

(

_Out_ PUCHAR

OutByte

)

Definition at line 299 of file kdcom.c.

{
    USHORT CpStatus;
    
    do
    {
        CpStatus = CpGetByte(&KdComPort, OutByte, TRUE, FALSE);
    } while (CpStatus == CP_GET_NODATA);
    
    /* Get the byte */
    if (CpStatus == CP_GET_SUCCESS)
    {
        return KdPacketReceived;
    }

    return KdPacketTimedOut;
}

KdpSendByte()

VOID NTAPI KdpSendByte

(

_In_ UCHAR

Byte

)

Definition at line 276 of file kdcom.c.

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

KdRestore()

NTSTATUS NTAPI KdRestore

(

IN BOOLEAN

SleepTransition

)

Definition at line 112 of file kdcom.c.

{
    /* Nothing to do on COM ports */
    return STATUS_SUCCESS;
}

KdSave()

NTSTATUS NTAPI KdSave

(

IN BOOLEAN

SleepTransition

)

Definition at line 104 of file kdcom.c.

{
    /* Nothing to do on COM ports */
    return STATUS_SUCCESS;
}

Variable Documentation

KdComPort

CPPORT KdComPort

Definition at line 43 of file kdcom.c.

KdComPortIrq

ULONG KdComPortIrq = 0

Definition at line 44 of file kdcom.c.