ReactOS 0.4.15-dev-7157-gb7dcc10
kdserial.c
Go to the documentation of this file.
1/*
2 * COPYRIGHT: GPL, see COPYING in the top level directory
3 * PROJECT: ReactOS kernel
4 * FILE: drivers/base/kddll/kdserial.c
5 * PURPOSE: Serial communication functions for the kernel debugger.
6 * PROGRAMMER: Timo Kreuzer (timo.kreuzer@reactos.org)
7 */
8
9#include "kddll.h"
10
11/* FUNCTIONS ******************************************************************/
12
13/******************************************************************************
14 * \name KdpSendBuffer
15 * \brief Sends a buffer of data to the serial KD port.
16 * \param Buffer Pointer to the data.
17 * \param Size Size of data in bytes.
18 */
19VOID
24{
25 PUCHAR ByteBuffer = Buffer;
26
27 while (Size-- > 0)
28 {
29 KdpSendByte(*ByteBuffer++);
30 }
31}
32
33/******************************************************************************
34 * \name KdpReceiveBuffer
35 * \brief Receives data from the KD port and fills a buffer.
36 * \param Buffer Pointer to a buffer that receives the data.
37 * \param Size Size of data to receive in bytes.
38 * \return KDP_PACKET_RECEIVED if successful.
39 * KDP_PACKET_TIMEOUT if the receive timed out.
40 */
46{
47 PUCHAR ByteBuffer = Buffer;
48 UCHAR Byte;
50
51 while (Size-- > 0)
52 {
53 /* Try to get a byte from the port */
56 return Status;
57
58 *ByteBuffer++ = Byte;
59 }
60
62}
63
64
65/******************************************************************************
66 * \name KdpReceivePacketLeader
67 * \brief Receives a packet leader from the KD port.
68 * \param PacketLeader Pointer to an ULONG that receives the packet leader.
69 * \return KDP_PACKET_RECEIVED if successful.
70 * KDP_PACKET_TIMEOUT if the receive timed out.
71 * KDP_PACKET_RESEND if a breakin byte was detected.
72 */
76 OUT PULONG PacketLeader)
77{
78 UCHAR Index = 0, Byte, Buffer[4];
79 KDP_STATUS KdStatus;
80
81 /* Set first character to 0 */
82 Buffer[0] = 0;
83
84 do
85 {
86 /* Receive a single byte */
87 KdStatus = KdpReceiveByte(&Byte);
88
89 /* Check for timeout */
90 if (KdStatus == KDP_PACKET_TIMEOUT)
91 {
92 /* Check if we already got a breakin byte */
94 {
95 return KDP_PACKET_RESEND;
96 }
97
98 /* Report timeout */
99 return KDP_PACKET_TIMEOUT;
100 }
101
102 /* Check if we received a byte */
103 if (KdStatus == KDP_PACKET_RECEIVED)
104 {
105 /* Check if this is a valid packet leader byte */
106 if (Byte == PACKET_LEADER_BYTE ||
108 {
109 /* Check if we match the first byte */
110 if (Byte != Buffer[0])
111 {
112 /* No, this is the new byte 0! */
113 Index = 0;
114 }
115
116 /* Store the byte in the buffer */
117 Buffer[Index] = Byte;
118
119 /* Continue with next byte */
120 Index++;
121 continue;
122 }
123
124 /* Check for breakin byte */
126 {
127 KDDBGPRINT("BREAKIN_PACKET_BYTE\n");
128 Index = 0;
129 Buffer[0] = Byte;
130 continue;
131 }
132 }
133
134 /* Restart */
135 Index = 0;
136 Buffer[0] = 0;
137 }
138 while (Index < 4);
139
140 /* Enable the debugger */
142 SharedUserData->KdDebuggerEnabled |= 0x00000002;
143
144 /* Return the received packet leader */
145 *PacketLeader = *(PULONG)Buffer;
146
147 return KDP_PACKET_RECEIVED;
148}
149
150/* EOF */
Definition: bufpool.h:45
#define FALSE
Definition: types.h:117
unsigned char Byte
Definition: zlib.h:37
#define KDDBGPRINT(...)
Definition: kddll.h:19
KDP_STATUS
Definition: kddll.h:26
@ KDP_PACKET_TIMEOUT
Definition: kddll.h:28
@ KDP_PACKET_RESEND
Definition: kddll.h:29
@ KDP_PACKET_RECEIVED
Definition: kddll.h:27
VOID NTAPI KdpSendBuffer(IN PVOID Buffer, IN ULONG Size)
Definition: kdserial.c:21
KDP_STATUS NTAPI KdpReceiveBuffer(OUT PVOID Buffer, IN ULONG Size)
Definition: kdserial.c:43
KDP_STATUS NTAPI KdpReceivePacketLeader(OUT PULONG PacketLeader)
Definition: kdserial.c:75
Status
Definition: gdiplustypes.h:25
KDP_STATUS NTAPI KdpReceiveByte(OUT PUCHAR OutByte)
Definition: kdcom.c:321
VOID NTAPI KdpSendByte(IN UCHAR Byte)
Definition: kdcom.c:291
#define SharedUserData
uint32_t * PULONG
Definition: typedefs.h:59
#define NTAPI
Definition: typedefs.h:36
#define IN
Definition: typedefs.h:39
unsigned char * PUCHAR
Definition: typedefs.h:53
uint32_t ULONG
Definition: typedefs.h:59
#define OUT
Definition: typedefs.h:40
_In_ WDFCOLLECTION _In_ ULONG Index
_Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_DEVICE_PROPERTY_DATA _In_ DEVPROPTYPE _In_ ULONG Size
Definition: wdfdevice.h:4533
#define BREAKIN_PACKET_BYTE
Definition: windbgkd.h:31
#define CONTROL_PACKET_LEADER_BYTE
Definition: windbgkd.h:35
#define PACKET_LEADER_BYTE
Definition: windbgkd.h:33
#define KD_DEBUGGER_NOT_PRESENT
Definition: kdfuncs.h:133
unsigned char UCHAR
Definition: xmlstorage.h:181