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

152 lines
3.4 KiB
C

/** @file
IOC IPC library
Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef __IOC_IPC_LIB_H__
#define __IOC_IPC_LIB_H__
#include <Uefi/UefiBaseType.h>
#include <Library/BaseLib.h>
#define IOC_IPC_PACKET_LENGTH_MAX 256
typedef enum {
IocIpcDeviceTypeUart,
IocIpcDeviceTypeMax
} IOC_IPC_DEVICE_TYPE;
typedef struct {
UINT32 BaseAddr;
UINT32 BaudRate;
UINT32 InputHertz;
UINT32 RegWidth;
} IOC_IPC_UART_DEVICE;
typedef union {
IOC_IPC_UART_DEVICE IpcDeviceUart;
} IOC_IPC_DEVICE;
typedef struct {
UINT8 Retries;
UINT8 TimeoutInitial;
UINT8 TimeoutXmit;
} IOC_IPC_MISC;
typedef struct {
IOC_IPC_DEVICE_TYPE IpcDeviceType;
IOC_IPC_DEVICE IpcDevice;
IOC_IPC_MISC IpcMisc;
} IOC_IPC_CONFIG_DATA;
/**
This function initializes IPC interface
@param[in] IpcDevice Specifies Ipc Interface Device
@retval EFI_SUCCESS The operation is done correctly.
@retval Others The operation fails.
**/
typedef
EFI_STATUS
(EFIAPI *IPC_FUNC_INIT) (
IN IOC_IPC_DEVICE *IpcDevice
);
/**
This function sends a single character via IPC interface
@param[in] IpcDevice Specifies Ipc Interface Device
@param[in] Ch Specifies a character to be sent
@retval EFI_SUCCESS The operation is done correctly.
@retval Others The operation fails.
**/
typedef
EFI_STATUS
(EFIAPI *IPC_FUNC_SEND) (
IN IOC_IPC_DEVICE *IpcDevice,
IN UINT8 Ch
);
/**
This function receives data via IPC interface
@param[in] IpcDevice Specifies Ipc Interface Device
@param[out] Buffer Memory address to store the received data
@param[in] Len Length of characters to be received
@param[in] Timeout Timeout in millisecond
@retval EFI_SUCCESS The operation is done correctly.
@retval Others The operation fails.
**/
typedef
EFI_STATUS
(EFIAPI *IPC_FUNC_RECV) (
IN IOC_IPC_DEVICE *IpcDevice,
OUT CHAR8 *Buffer,
IN UINT32 Len,
IN UINT32 Timeout
);
/**
This function resets IPC transmission
@param[in] IpcDevice Specifies Ipc Interface Device
@retval EFI_SUCCESS The operation is done correctly.
@retval Others The operation fails.
**/
typedef
EFI_STATUS
(EFIAPI *IPC_FUNC_RESET) (
IN IOC_IPC_DEVICE *IpcDevice
);
typedef struct {
IPC_FUNC_INIT IpcInitialize;
IPC_FUNC_SEND IpcSend;
IPC_FUNC_RECV IpcReceive;
IPC_FUNC_RESET IpcReset;
} IOC_IPC_FUNC;
/**
The function gets config data from IOC.
Based on IpcConfig, this function will query config data from IOC.
@param[in] IpcConfig IPC config information
@param[out] Buffer Memory address to store the received data
@retval The number of bytes received from IOC
**/
UINT32
EFIAPI
QueryConfigDataFromIoc (
IN IOC_IPC_CONFIG_DATA *IpcConfig,
OUT CHAR8 *Buffer
);
/**
This will trigger system reset via IOC.
@param[in] IpcConfig IPC config information
@param[in] ResetType Cold, Warm or Shutdown
**/
VOID
RequestResetSystemToIoc (
IN IOC_IPC_CONFIG_DATA *IpcConfig,
IN EFI_RESET_TYPE ResetType
);
#endif /* __IOC_IPC_LIB_H__ */