VirtualBox

source: vbox/trunk/src/VBox/Runtime/common/log/logcom.cpp@ 17416

Last change on this file since 17416 was 8245, checked in by vboxsync, 17 years ago

rebranding: IPRT files again.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 4.3 KB
Line 
1/* $Id: logcom.cpp 8245 2008-04-21 17:24:28Z vboxsync $ */
2/** @file
3 * IPRT - Logging to Serial Port.
4 */
5
6/*
7 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 *
26 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
27 * Clara, CA 95054 USA or visit http://www.sun.com if you need
28 * additional information or have any questions.
29 */
30
31/*******************************************************************************
32* Defined Constants And Macros *
33*******************************************************************************/
34#ifndef IPRT_UART_BASE
35/** The port address of the COM port to log to.
36 *
37 * To override the default (COM1) append IPRT_UART_BASE=0xWXYZ to DEFS in your
38 * LocalConfig.kmk. Alternatively you can edit this file, but the don't forget
39 * to also update the default found in VBox/asmdefs.h.
40 *
41 * Standard port assignments are: COM1=0x3f8, COM2=0x2f8, COM3=0x3e8, COM4=0x2e8.
42 */
43# define IPRT_UART_BASE 0x3f8
44#endif
45
46
47/*******************************************************************************
48* Header Files *
49*******************************************************************************/
50#include <iprt/log.h>
51#include <iprt/asm.h>
52#include <iprt/stdarg.h>
53#include <iprt/string.h>
54
55
56/*******************************************************************************
57* Internal Functions *
58*******************************************************************************/
59static DECLCALLBACK(size_t) rtLogComOutput(void *pv, const char *pachChars, size_t cbChars);
60
61
62/**
63 * Prints a formatted string to the serial port used for logging.
64 *
65 * @returns Number of bytes written.
66 * @param pszFormat Format string.
67 * @param ... Optional arguments specified in the format string.
68 */
69RTDECL(size_t) RTLogComPrintf(const char *pszFormat, ...)
70{
71 va_list args;
72 size_t cb;
73 va_start(args, pszFormat);
74 cb = RTLogComPrintfV(pszFormat, args);
75 va_end(args);
76
77 return cb;
78}
79
80
81/**
82 * Prints a formatted string to the serial port used for logging.
83 *
84 * @returns Number of bytes written.
85 * @param pszFormat Format string.
86 * @param args Optional arguments specified in the format string.
87 */
88RTDECL(size_t) RTLogComPrintfV(const char *pszFormat, va_list args)
89{
90 return RTLogFormatV(rtLogComOutput, NULL, pszFormat, args);
91}
92
93
94/**
95 * Callback for RTLogFormatV which writes to the com port.
96 * See PFNLOGOUTPUT() for details.
97 */
98static DECLCALLBACK(size_t) rtLogComOutput(void *pv, const char *pachChars, size_t cbChars)
99{
100 if (cbChars)
101 RTLogWriteCom(pachChars, cbChars);
102 return cbChars;
103}
104
105
106/**
107 * Write log buffer to COM port.
108 *
109 * @param pach Pointer to the buffer to write.
110 * @param cb Number of bytes to write.
111 */
112RTDECL(void) RTLogWriteCom(const char *pach, size_t cb)
113{
114 const uint8_t *pu8;
115 for (pu8 = (const uint8_t *)pach; cb-- > 0; pu8++)
116 {
117 register unsigned cMaxWait;
118 register uint8_t u8;
119
120 /* expand \n -> \r\n */
121 if (*pu8 == '\n')
122 RTLogWriteCom("\r", 1);
123
124 /* Check if port is ready. */
125 cMaxWait = ~0;
126 do
127 {
128 u8 = ASMInU8(IPRT_UART_BASE + 5);
129 cMaxWait--;
130 } while (!(u8 & 0x20) && u8 != 0xff && cMaxWait);
131
132 /* write */
133 ASMOutU8(IPRT_UART_BASE, *pu8);
134 }
135}
136
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette