Files
Mike Crowe 990e3e81e6 Use LF line endings in the repository
Convert the line endings stored for all text files in the repository to
LF. The majority previously used DOS-style CRLF line endings. Add a
.gitattributes file to enforce this and treat certain extensions as
never being text files.

Update PatchCheck.py to insist on LF line endings rather than CRLF.
However, its other checks fail on this commit due to lots of
pre-existing complaints that it only notices because the line endings
have changed.

Silicon/QemuSocPkg/FspBin/Patches/0001-Build-QEMU-FSP-2.0-binaries.patch
needs to be treated as binary since it contains a mixture of line
endings.

This change has implications depending on the client platform you are
using the repository from:

* Windows

The usual configuration for Git on Windows means that text files will
be checked out to the work tree with DOS-style CRLF line endings. If
that's not the case then you can configure Git to do so for the entire
machine with:

 git config --global core.autocrlf true

or for just the repository with:

 git config core.autocrlf true

Line endings will be normalised to LF when they are committed to the
repository. If you commit a text file with only LF line endings then it
will be converted to CRLF line endings in your work tree.

* Linux, MacOS and other Unices

The usual configuration for Git on such platforms is to check files out
of the repository with LF line endings. This is probably the right thing
for you. In the unlikely even that you are using Git on Unix but editing
or compiling on Windows for some reason then you may need to tweak your
configuration to force the use of CRLF line endings as described above.

* General

For more information see
https://docs.github.com/en/get-started/getting-started-with-git/configuring-git-to-handle-line-endings .

Fixes: https://github.com/slimbootloader/slimbootloader/issues/1400
Signed-off-by: Mike Crowe <mac@mcrowe.com>
2021-11-10 12:46:42 -08:00

142 lines
4.5 KiB
C

/** @file
Provide Console output library functions.
Copyright (c) 2018 - 2020, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef __CONSOLE_OUT_LIB_H__
#define __CONSOLE_OUT_LIB_H__
#include <PiPei.h>
#include <Library/BaseLib.h>
//
// NOT RECOMMEND to use __CONSOLE_PRINT directly
//
#define __CONSOLE_PRINT_FUNC(Format, ...) \
do { \
ConsolePrint (Format, ##__VA_ARGS__); \
} while (FALSE)
#define __CONSOLE_PRINT_UNICODE_FUNC(Format, ...) \
do { \
ConsolePrintUnicode (Format, ##__VA_ARGS__); \
} while (FALSE)
#define __CONSOLE_PRINT_CONDITION_FUNC(PrintLevel, Format, ...) \
do { \
ConsolePrint (Format, ##__VA_ARGS__); \
} while (FALSE)
#define __CONSOLE_PRINT_UNICODE_CONDITION_FUNC(PrintLevel, Format, ...) \
do { \
ConsolePrintUnicode (Format, ##__VA_ARGS__); \
} while (FALSE)
#define __CONSOLE_PRINT_CONDITION(Expression) \
__CONSOLE_PRINT_CONDITION_FUNC Expression
#define __CONSOLE_PRINT_UNICODE_CONDITION(Expression) \
__CONSOLE_PRINT_UNICODE_CONDITION_FUNC Expression
//
// NOT RECOMMEND to use __CONSOLE_PRINT directly
//
//
// CONSOLE_PRINT will redirect log messages to consoles
// Expression does not have PrintLevel(ErrorLevel).
//
#define CONSOLE_PRINT(Expression) \
__CONSOLE_PRINT_FUNC Expression
#define CONSOLE_PRINT_UNICODE(Expression) \
__CONSOLE_PRINT_UNICODE_FUNC Expression
//
// ErrorLevel is ignored when log message is redirect to consoles.
// Valid only at DEBUG().
//
#define CONSOLE_PRINT_CONDITION(ConsoleOut, Expression) \
do { \
if (ConsoleOut) { \
__CONSOLE_PRINT_CONDITION(Expression); \
} else { \
DEBUG(Expression); \
} \
} while (FALSE)
#define CONSOLE_PRINT_UNICODE_CONDITION(ConsoleOut, Expression) \
do { \
if (ConsoleOut) { \
__CONSOLE_PRINT_UNICODE_CONDITION(Expression); \
} else { \
DEBUG(Expression); \
} \
} while (FALSE)
typedef enum {
ConsoleOutSerialPort = BIT0,
ConsoleOutFrameBuffer = BIT1,
ConsoleOutDebugPort = BIT2,
ConsoleOutAll = 0xFFFFFFFF,
} CONSOLE_OUT_DEVICE_TYPE;
/**
Write data from buffer to the console.
Writes NumberOfBytes data bytes from Buffer to the virtual console.
If Buffer is NULL, then ASSERT().
If NumberOfBytes is zero, then return 0.
@param Buffer Pointer to the data buffer to be written.
@param NumberOfBytes Number of bytes to write to the console.
@retval >0 The number of bytes written to the console.
**/
UINTN
EFIAPI
ConsoleWrite (
IN UINT8 *Buffer,
IN UINTN NumberOfBytes
);
/**
Print Ascii debug message to consoles
If Format is NULL, then ASSERT().
@param Format The format string for the debug message to print.
@param ... The variable argument list whose contents are accessed
based on the format string specified by Format.
**/
UINTN
EFIAPI
ConsolePrint (
IN CONST CHAR8 *Format,
...
);
/**
Print Unicode debug message to consoles
If Format is NULL, then ASSERT().
@param Format The format string for the debug message to print.
@param ... The variable argument list whose contents are accessed
based on the format string specified by Format.
**/
UINTN
EFIAPI
ConsolePrintUnicode (
IN CONST CHAR16 *Format,
...
);
#endif