1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
/* $Id: logcom.cpp $ */
/** @file
* IPRT - Logging to Serial Port.
*/
/*
* Copyright (C) 2006-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
/*********************************************************************************************************************************
* Defined Constants And Macros *
*********************************************************************************************************************************/
#ifndef IPRT_UART_BASE
/** The port address of the COM port to log to.
*
* To override the default (COM1) append IPRT_UART_BASE=0xWXYZ to DEFS in your
* LocalConfig.kmk. Alternatively you can edit this file, but the don't forget
* to also update the default found in VBox/asmdefs.h.
*
* Standard port assignments are: COM1=0x3f8, COM2=0x2f8, COM3=0x3e8, COM4=0x2e8.
*/
# define IPRT_UART_BASE 0x3f8
#endif
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#include <iprt/log.h>
#include "internal/iprt.h"
#include <iprt/asm.h>
#if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86) /** @todo consider fixing the config instead. */
# include <iprt/asm-amd64-x86.h>
#endif
#include <iprt/stdarg.h>
#include <iprt/string.h>
/*********************************************************************************************************************************
* Internal Functions *
*********************************************************************************************************************************/
static DECLCALLBACK(size_t) rtLogComOutput(void *pv, const char *pachChars, size_t cbChars);
/**
* Prints a formatted string to the serial port used for logging.
*
* @returns Number of bytes written.
* @param pszFormat Format string.
* @param ... Optional arguments specified in the format string.
*/
RTDECL(size_t) RTLogComPrintf(const char *pszFormat, ...)
{
va_list args;
size_t cb;
va_start(args, pszFormat);
cb = RTLogComPrintfV(pszFormat, args);
va_end(args);
return cb;
}
RT_EXPORT_SYMBOL(RTLogComPrintf);
/**
* Prints a formatted string to the serial port used for logging.
*
* @returns Number of bytes written.
* @param pszFormat Format string.
* @param args Optional arguments specified in the format string.
*/
RTDECL(size_t) RTLogComPrintfV(const char *pszFormat, va_list args)
{
return RTLogFormatV(rtLogComOutput, NULL, pszFormat, args);
}
RT_EXPORT_SYMBOL(RTLogComPrintfV);
/**
* Callback for RTLogFormatV which writes to the com port.
* See PFNLOGOUTPUT() for details.
*/
static DECLCALLBACK(size_t) rtLogComOutput(void *pv, const char *pachChars, size_t cbChars)
{
NOREF(pv);
if (cbChars)
RTLogWriteCom(pachChars, cbChars);
return cbChars;
}
/**
* Write log buffer to COM port.
*
* @param pach Pointer to the buffer to write.
* @param cb Number of bytes to write.
*/
RTDECL(void) RTLogWriteCom(const char *pach, size_t cb)
{
#if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)
const uint8_t *pu8;
for (pu8 = (const uint8_t *)pach; cb-- > 0; pu8++)
{
unsigned cMaxWait;
uint8_t u8;
/* expand \n -> \r\n */
if (*pu8 == '\n')
RTLogWriteCom("\r", 1);
/* Check if port is ready. */
cMaxWait = ~0U;
do
{
u8 = ASMInU8(IPRT_UART_BASE + 5);
cMaxWait--;
} while (!(u8 & 0x20) && u8 != 0xff && cMaxWait);
/* write */
ASMOutU8(IPRT_UART_BASE, *pu8);
}
#else
/* PORTME? */
#endif
}
RT_EXPORT_SYMBOL(RTLogWriteCom);
|
