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

Include dependency graph for kdcom.c:

Macros
#define	DEFAULT_DEBUG_PORT 2 /* COM2 */

#define	DEFAULT_DEBUG_COM1_IRQ 4

#define	DEFAULT_DEBUG_COM2_IRQ 3

#define	DEFAULT_DEBUG_BAUD_RATE 115200

#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)

KDP_STATUS NTAPI	KdpPollByte (OUT PUCHAR OutByte)

KDP_STATUS NTAPI	KdpReceiveByte (OUT PUCHAR OutByte)

KDP_STATUS NTAPI	KdpPollBreakIn (VOID)

Variables
CPPORT	KdComPort

ULONG	KdComPortIrq = 0

Macro Definition Documentation

◆ DEFAULT_BAUD_RATE

#define DEFAULT_BAUD_RATE 19200

Definition at line 29 of file kdcom.c.

◆ DEFAULT_DEBUG_BAUD_RATE

#define DEFAULT_DEBUG_BAUD_RATE 115200

Definition at line 28 of file kdcom.c.

◆ DEFAULT_DEBUG_COM1_IRQ

#define DEFAULT_DEBUG_COM1_IRQ 4

Definition at line 26 of file kdcom.c.

◆ DEFAULT_DEBUG_COM2_IRQ

#define DEFAULT_DEBUG_COM2_IRQ 3

Definition at line 27 of file kdcom.c.

◆ DEFAULT_DEBUG_PORT

#define DEFAULT_DEBUG_PORT 2 /* COM2 */

Definition at line 25 of file kdcom.c.

◆ MAX_COM_PORTS

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

Definition at line 48 of file kdcom.c.

Function Documentation

◆ KdD0Transition()

NTSTATUS NTAPI KdD0Transition ( VOID )

Definition at line 99 of file kdcom.c.

{
    return STATUS_SUCCESS;
}

Referenced by KdPowerTransition().

◆ KdD3Transition()

NTSTATUS NTAPI KdD3Transition ( VOID )

Definition at line 106 of file kdcom.c.

{
    return STATUS_SUCCESS;
}

Referenced by KdPowerTransition().

◆ KdDebuggerInitialize0()

NTSTATUS NTAPI KdDebuggerInitialize0 ( IN PLOADER_PARAMETER_BLOCK LoaderBlock OPTIONAL )

Definition at line 158 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
 
    KDDBGPRINT("KdDebuggerInitialize0\n");
 
    /* Initialize the port */
    return KdpPortInitialize(ComPortNumber, ComPortBaudRate);
}

Referenced by KdInitSystem().

◆ KdDebuggerInitialize1()

NTSTATUS NTAPI KdDebuggerInitialize1 ( IN PLOADER_PARAMETER_BLOCK LoaderBlock OPTIONAL )

Definition at line 283 of file kdcom.c.

{
    return STATUS_SUCCESS;
}

Referenced by Phase1InitializationDiscard().

◆ 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;
}

Referenced by KdReceivePacket().

◆ 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;
    }
}

Referenced by gdb_receive_packet(), and KdpPollBreakIn().

◆ KdpPortInitialize()

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

Definition at line 129 of file kdcom.c.

{
    NTSTATUS Status;
 
    KDDBGPRINT("KdpPortInitialize, Port = COM%ld\n", ComPortNumber);
 
    Status = CpInitialize(&KdComPort,
                          UlongToPtr(BaseArray[ComPortNumber]),
                          ComPortBaudRate);
    if (!NT_SUCCESS(Status))
    {
        return STATUS_INVALID_PARAMETER;
    }
    else
    {
        KdComPortInUse = KdComPort.Address;
        return STATUS_SUCCESS;
    }
}

Referenced by KdDebuggerInitialize0().

◆ 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().

◆ 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().

◆ KdRestore()

NTSTATUS NTAPI KdRestore ( IN BOOLEAN SleepTransition )

Definition at line 121 of file kdcom.c.

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

Referenced by KdExitDebugger(), and KdReportProcessorChange().

◆ KdSave()

NTSTATUS NTAPI KdSave ( IN BOOLEAN SleepTransition )

Definition at line 113 of file kdcom.c.

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

Referenced by KdEnterDebugger(), and KdReportProcessorChange().

Variable Documentation

◆ KdComPort

CPPORT KdComPort

Definition at line 52 of file kdcom.c.

Referenced by KdpPollByte(), KdpPortInitialize(), KdpReceiveByte(), and KdpSendByte().

◆ KdComPortIrq

ULONG KdComPortIrq = 0

Definition at line 53 of file kdcom.c.