kdcom.c File Reference

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

Include dependency graph for kdcom.c:

Go to the source code of this file.

Macros
#define	CONST_STR_LEN(x)   (sizeof(x)/sizeof(x[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_ PUCHAR PortAddress, _In_ ULONG BaudRate)
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

Macro Definition Documentation

CONST_STR_LEN

#define CONST_STR_LEN

(

x

)

(sizeof(x)/sizeof(x[0]) - 1)

Function Documentation

KdD0Transition()

NTSTATUS NTAPI KdD0Transition

(

VOID

)

Definition at line 65 of file kdcom.c.

{
    return STATUS_SUCCESS;
}

KdD3Transition()

NTSTATUS NTAPI KdD3Transition

(

VOID

)

Definition at line 72 of file kdcom.c.

{
    return STATUS_SUCCESS;
}

KdDebuggerInitialize0()

NTSTATUS NTAPI KdDebuggerInitialize0

(

IN PLOADER_PARAMETER_BLOCK LoaderBlock

OPTIONAL

)

Definition at line 117 of file kdcom.c.

{
#define CONST_STR_LEN(x) (sizeof(x)/sizeof(x[0]) - 1)
 
    ULONG ComPortNumber   = DEFAULT_DEBUG_PORT;
    ULONG ComPortBaudRate = DEFAULT_DEBUG_BAUD_RATE;
    PUCHAR ComPortAddress = NULL;
 
    PSTR CommandLine, PortString, BaudString;
    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");
 
        /* Check if we got the DEBUGPORT parameter */
        if (PortString)
        {
            /* Move past the actual string and any spaces */
            PortString += CONST_STR_LEN("DEBUGPORT");
            while (*PortString == ' ') ++PortString;
            /* Skip the equals sign */
            if (*PortString) ++PortString;
 
            /* Do we have a serial port? Recognize both
             * 'DEBUGPORT=GDB' and 'DEBUGPORT=COM' syntaxes. */
            if (_strnicmp(PortString, "GDB", CONST_STR_LEN("GDB")) != 0 &&
                _strnicmp(PortString, "COM", CONST_STR_LEN("COM")) != 0)
            {
                return STATUS_INVALID_PARAMETER;
            }
 
            /* Check for a valid serial port */
            PortString += CONST_STR_LEN("COM"); // Same as len("GDB")
            if (*PortString != ':')
            {
                Value = (ULONG)atol(PortString);
                if (Value > MAX_COM_PORTS)
                    return STATUS_INVALID_PARAMETER;
                // if (Value > 0 && Value <= MAX_COM_PORTS)
                /* Set the port to use */
                ComPortNumber = Value;
            }
            else
            {
                /* Retrieve and set its address */
                Value = strtoul(PortString + 1, NULL, 0);
                if (Value)
                {
                    ComPortNumber = 0;
                    ComPortAddress = UlongToPtr(Value);
                }
            }
        }
 
        /* Check if we got a baud rate */
        if (BaudString)
        {
            /* Move past the actual string and any spaces */
            BaudString += CONST_STR_LEN("BAUDRATE");
            while (*BaudString == ' ') ++BaudString;
 
            /* Make sure we have a rate */
            if (*BaudString)
            {
                /* Read and set it */
                Value = (ULONG)atol(BaudString + 1);
                if (Value) ComPortBaudRate = Value;
            }
        }
    }
 
    if (!ComPortAddress)
        ComPortAddress = UlongToPtr(BaseArray[ComPortNumber]);
 
#ifdef KDDEBUG
    /*
     * Try to find a free COM port and use it as the KD debugging port.
     * NOTE: Inspired by freeldr/comm/rs232.c, Rs232PortInitialize(...)
     */
    {
    /*
     * Enumerate COM ports from the last to the first one, and stop
     * when we find a valid port. If we reach the first list element
     * (the undefined COM port), no valid port was found.
     */
    PUCHAR Address = NULL;
    ULONG ComPort;
    for (ComPort = MAX_COM_PORTS; ComPort > 0; ComPort--)
    {
        /* Check if the port exist; skip the KD port */
        Address = UlongToPtr(BaseArray[ComPort]);
        if ((Address != ComPortAddress) && CpDoesPortExist(Address))
            break;
    }
    if (ComPort != 0 && Address != NULL)
        CpInitialize(&KdDebugComPort, Address, DEFAULT_BAUD_RATE);
    }
#endif
 
    /* Initialize the port */
    return KdpPortInitialize(ComPortAddress, ComPortBaudRate);
}

KdDebuggerInitialize1()

NTSTATUS NTAPI KdDebuggerInitialize1

(

IN PLOADER_PARAMETER_BLOCK LoaderBlock

OPTIONAL

)

Definition at line 238 of file kdcom.c.

{
    return STATUS_SUCCESS;
}

KdpPollBreakIn()

KDSTATUS NTAPI KdpPollBreakIn

(

VOID

)

Definition at line 289 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 254 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_ PUCHAR	PortAddress,
		_In_ ULONG	BaudRate
	)

Definition at line 95 of file kdcom.c.

{
    NTSTATUS Status;
 
    Status = CpInitialize(&KdComPort, PortAddress, BaudRate);
    if (!NT_SUCCESS(Status))
        return STATUS_INVALID_PARAMETER;
 
    KdComPortInUse = KdComPort.Address;
    return STATUS_SUCCESS;
}

KdpReceiveByte()

KDSTATUS NTAPI KdpReceiveByte

(

OUT PUCHAR

OutByte

)

Definition at line 269 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 246 of file kdcom.c.

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

KdRestore()

NTSTATUS NTAPI KdRestore

(

IN BOOLEAN

SleepTransition

)

Definition at line 87 of file kdcom.c.

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

KdSave()

NTSTATUS NTAPI KdSave

(

IN BOOLEAN

SleepTransition

)

Definition at line 79 of file kdcom.c.

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

Variable Documentation

KdComPort

CPPORT KdComPort

Definition at line 19 of file kdcom.c.