|
|
/* ----------------------------------------------------------------------------
|
|
|
* Copyright (c) Huawei Technologies Co., Ltd. 2013-2020. All rights reserved.
|
|
|
* Description: LiteOS Printf Implementation
|
|
|
* Author: Huawei LiteOS Team
|
|
|
* Create: 2013-01-01
|
|
|
* Redistribution and use in source and binary forms, with or without modification,
|
|
|
* are permitted provided that the following conditions are met:
|
|
|
* 1. Redistributions of source code must retain the above copyright notice, this list of
|
|
|
* conditions and the following disclaimer.
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
|
|
|
* of conditions and the following disclaimer in the documentation and/or other materials
|
|
|
* provided with the distribution.
|
|
|
* 3. Neither the name of the copyright holder nor the names of its contributors may be used
|
|
|
* to endorse or promote products derived from this software without specific prior written
|
|
|
* permission.
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
|
|
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
|
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
|
|
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
|
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
|
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
|
|
|
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
|
|
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
|
|
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
|
|
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
* --------------------------------------------------------------------------- */
|
|
|
/* ---------------------------------------------------------------------------
|
|
|
* Notice of los_printf.c Modification
|
|
|
*===============================================
|
|
|
* When this file is getting modified, it should consider the compatibility of SE LiteOS.
|
|
|
* It should not add OS inner invocation, which is not allowed to be accessed in user space.
|
|
|
* But it's allowed to invoke syscall interface.
|
|
|
*---------------------------------------------------------------------------- */
|
|
|
/*这段代码是一个输出控制模块，根据不同的输出类型将字符串输出到不同的设备上*/
|
|
|
#ifdef LOSCFG_LIB_LIBC
|
|
|
#include "unistd.h"
|
|
|
#endif
|
|
|
#include "los_memory.h"
|
|
|
#include "uart.h"
|
|
|
#ifdef LOSCFG_FS_VFS
|
|
|
#include "console.h"
|
|
|
#endif
|
|
|
#ifdef LOSCFG_SHELL_DMESG
|
|
|
#include "dmesg_pri.h"
|
|
|
#endif
|
|
|
#ifdef LOSCFG_SHELL_EXCINFO_DUMP
|
|
|
#include "los_exc_pri.h"
|
|
|
#endif
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
#if __cplusplus
|
|
|
extern "C" {
|
|
|
#endif /* __cplusplus */
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
|
#define SIZEBUF 256
|
|
|
|
|
|
typedef enum {
|
|
|
NO_OUTPUT = 0,
|
|
|
UART_OUTPUT = 1,
|
|
|
CONSOLE_OUTPUT = 2,
|
|
|
EXC_OUTPUT = 3
|
|
|
} OutputType;
|
|
|
//ErrorMsg：用于输出错误信息，当字符串输出非法或者vsnprintf_s函数失败时调用
|
|
|
STATIC VOID ErrorMsg(VOID)
|
|
|
{
|
|
|
const CHAR *p = "Output illegal string! vsnprintf_s failed!\n";
|
|
|
UartPuts(p, (UINT32)strlen(p), UART_WITH_LOCK);
|
|
|
}
|
|
|
//UartOutput：实际将字符串输出到串口的函数，根据配置可能会进行一些额外的处理
|
|
|
STATIC VOID UartOutput(const CHAR *str, UINT32 len, BOOL isLock)
|
|
|
{
|
|
|
#ifdef LOSCFG_SHELL_DMESG
|
|
|
if (!OsCheckUartLock()) {
|
|
|
UartPuts(str, len, isLock);
|
|
|
}
|
|
|
if (isLock != UART_WITHOUT_LOCK) {
|
|
|
(VOID)OsLogMemcpyRecord(str, len);
|
|
|
}
|
|
|
#else
|
|
|
UartPuts(str, len, isLock);
|
|
|
#endif
|
|
|
}
|
|
|
//OutputControl：根据输出类型选择相应的输出设备，并调用对应的输出函数
|
|
|
STATIC VOID OutputControl(const CHAR *str, UINT32 len, OutputType type)
|
|
|
{
|
|
|
switch (type) {
|
|
|
case CONSOLE_OUTPUT:
|
|
|
#ifdef LOSCFG_KERNEL_CONSOLE
|
|
|
if (ConsoleEnable() == TRUE) {
|
|
|
(VOID)write(STDOUT_FILENO, str, (size_t)len);
|
|
|
break;
|
|
|
}
|
|
|
#endif
|
|
|
/* fall-through */
|
|
|
case UART_OUTPUT:
|
|
|
UartOutput(str, len, UART_WITH_LOCK);
|
|
|
break;
|
|
|
case EXC_OUTPUT:
|
|
|
UartOutput(str, len, UART_WITHOUT_LOCK);
|
|
|
break;
|
|
|
default:
|
|
|
break;
|
|
|
}
|
|
|
return;
|
|
|
}
|
|
|
//OsVprintfFree：释放动态分配的缓冲区内存
|
|
|
STATIC VOID OsVprintfFree(CHAR *buf, UINT32 bufLen)
|
|
|
{
|
|
|
if (bufLen != SIZEBUF) {
|
|
|
(VOID)LOS_MemFree(m_aucSysMem0, buf);
|
|
|
}
|
|
|
}
|
|
|
//OsVprintf：核心函数，根据给定的格式化字符串和可变参数，进行字符串格式化并输出到相应的设备
|
|
|
STATIC VOID OsVprintf(const CHAR *fmt, va_list ap, OutputType type)
|
|
|
{
|
|
|
INT32 len;
|
|
|
const CHAR *errMsgMalloc = "OsVprintf, malloc failed!\n";
|
|
|
const CHAR *errMsgLen = "OsVprintf, length overflow!\n";
|
|
|
CHAR aBuf[SIZEBUF] = {0};
|
|
|
CHAR *bBuf = NULL;
|
|
|
UINT32 bufLen = SIZEBUF;
|
|
|
|
|
|
bBuf = aBuf;
|
|
|
len = vsnprintf_s(bBuf, bufLen, bufLen - 1, fmt, ap);
|
|
|
if ((len == -1) && (*bBuf == '\0')) {
|
|
|
/* parameter is illegal or some features in fmt dont support */
|
|
|
ErrorMsg();
|
|
|
return;
|
|
|
}
|
|
|
|
|
|
while (len == -1) {
|
|
|
/* bBuf is not enough */
|
|
|
OsVprintfFree(bBuf, bufLen);
|
|
|
|
|
|
bufLen = bufLen << 1;
|
|
|
if ((INT32)bufLen <= 0) {
|
|
|
UartPuts(errMsgLen, (UINT32)strlen(errMsgLen), UART_WITH_LOCK);
|
|
|
return;
|
|
|
}
|
|
|
bBuf = (CHAR *)LOS_MemAlloc(m_aucSysMem0, bufLen);
|
|
|
if (bBuf == NULL) {
|
|
|
UartPuts(errMsgMalloc, (UINT32)strlen(errMsgMalloc), UART_WITH_LOCK);
|
|
|
return;
|
|
|
}
|
|
|
len = vsnprintf_s(bBuf, bufLen, bufLen - 1, fmt, ap);
|
|
|
if (*bBuf == '\0') {
|
|
|
/* parameter is illegal or some features in fmt dont support */
|
|
|
(VOID)LOS_MemFree(m_aucSysMem0, bBuf);
|
|
|
ErrorMsg();
|
|
|
return;
|
|
|
}
|
|
|
}
|
|
|
*(bBuf + len) = '\0';
|
|
|
OutputControl(bBuf, len, type);
|
|
|
OsVprintfFree(bBuf, bufLen);
|
|
|
}
|
|
|
//UartVprintf、ConsoleVprintf、UartPrintf、dprintf、LkDprintf、DmesgPrintf、ExcPrintf、PrintExcInfo：这些函数都是对OsVprintf的封装，提供了不同的输出接口，在不同的场景下调用OsVprintf来完成字符串的格式化和输出
|
|
|
VOID UartVprintf(const CHAR *fmt, va_list ap)
|
|
|
{
|
|
|
OsVprintf(fmt, ap, UART_OUTPUT);
|
|
|
}
|
|
|
|
|
|
VOID ConsoleVprintf(const CHAR *fmt, va_list ap)
|
|
|
{
|
|
|
OsVprintf(fmt, ap, CONSOLE_OUTPUT);
|
|
|
}
|
|
|
|
|
|
__attribute__((noinline)) VOID UartPrintf(const CHAR *fmt, ...)
|
|
|
{
|
|
|
va_list ap;
|
|
|
va_start(ap, fmt);
|
|
|
OsVprintf(fmt, ap, UART_OUTPUT);
|
|
|
va_end(ap);
|
|
|
}
|
|
|
|
|
|
__attribute__ ((noinline)) VOID dprintf(const CHAR *fmt, ...)
|
|
|
{
|
|
|
va_list ap;
|
|
|
va_start(ap, fmt);
|
|
|
OsVprintf(fmt, ap, CONSOLE_OUTPUT);
|
|
|
va_end(ap);
|
|
|
}
|
|
|
|
|
|
VOID LkDprintf(const CHAR *fmt, va_list ap)
|
|
|
{
|
|
|
OsVprintf(fmt, ap, CONSOLE_OUTPUT);
|
|
|
}
|
|
|
|
|
|
#ifdef LOSCFG_SHELL_DMESG
|
|
|
VOID DmesgPrintf(const CHAR *fmt, va_list ap)
|
|
|
{
|
|
|
OsVprintf(fmt, ap, CONSOLE_OUTPUT);
|
|
|
}
|
|
|
#endif
|
|
|
|
|
|
__attribute__((noinline)) VOID ExcPrintf(const CHAR *fmt, ...)
|
|
|
{
|
|
|
va_list ap;
|
|
|
va_start(ap, fmt);
|
|
|
/* uart output without print-spinlock */
|
|
|
OsVprintf(fmt, ap, EXC_OUTPUT);
|
|
|
va_end(ap);
|
|
|
}
|
|
|
|
|
|
VOID PrintExcInfo(const CHAR *fmt, ...)
|
|
|
{
|
|
|
va_list ap;
|
|
|
va_start(ap, fmt);
|
|
|
/* uart output without print-spinlock */
|
|
|
OsVprintf(fmt, ap, EXC_OUTPUT);
|
|
|
#ifdef LOSCFG_SHELL_EXCINFO_DUMP
|
|
|
WriteExcBufVa(fmt, ap);
|
|
|
#endif
|
|
|
va_end(ap);
|
|
|
}
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
#if __cplusplus
|
|
|
}
|
|
|
#endif /* __cplusplus */
|
|
|
#endif /* __cplusplus */
|
