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

171 lines
6.3 KiB
C

/** @file
Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
/*
* RpmbLib.h
*/
#ifndef _RPMB_LIB_H_
#define _RPMB_LIB_H_
#include <Uefi/UefiBaseType.h>
#include <Guid/OsBootOptionGuid.h>
typedef enum {
RpmbResponseOK,
RpmbResponseGeneralFailure,
RpmbResponseAuthFailure,
RpmbResponseCounterFailure,
RpmbResponseAddressFailure,
RpmbResponseWriteFailure,
RpmbResponseReadFailure,
RpmbResponseNoAuthKeyProgram,
RpmbResponseWriteCounterExpired = 0X80,
} RPMB_RESPONSE_RESULT;
#pragma pack(1)
typedef struct {
UINT8 Stuff[196];
UINT8 KeyMac[32];
UINT8 Data[256];
UINT8 Nonce[16];
UINT32 WriteCounter;
UINT16 Address;
UINT16 BlockCnt;
UINT16 Result;
UINT16 ReqResp;
} RPMB_DATA_FRAME;
#pragma pack()
#define RPMB_RESPONSE_KEY_WRITE 0x0100
#define RPMB_RESPONSE_COUNTER_READ 0x0200
#define RPMB_RESPONSE_AUTH_WRITE 0x0300
#define RPMB_RESPONSE_AUTH_READ 0x0400
#define RPMB_RESPONSE_READ_RESULT 0x0500
#define RPMB_REQUEST_KEY_WRITE 0x0001
#define RPMB_REQUEST_COUNTER_READ 0x0002
#define RPMB_REQUEST_AUTH_WRITE 0x0003
#define RPMB_REQUEST_AUTH_READ 0x0004
#define RPMB_REQUEST_STATUS 0x0005
#define RPMB_BLOCK_SIZE 256
/**
This function reads the counter value of the RPMB Partition.
@param[in] MediumType Current Medium Type option: eMMC, UFS, NVMe
@param[in] Key Input Key to authenticate and compare against the
embbeded MAC in RPMB_DATA_FRAME.
@param[in] KeySize Size of the Input Key.
@param[out] WriteCounter How many times a successful write request has been done so far.
@param[out] ResponseResult Output coming from CounterFrame->Result
@retval EFI_SUCCESS The operation is done correctly.
@retval Others The operation fails due to some error.
**/
EFI_STATUS
EFIAPI
RpmbGetCounter (
IN OS_BOOT_MEDIUM_TYPE MediumType,
IN CONST UINT8 *Key,
IN UINT8 KeySize,
OUT UINT32 *WriteCounter,
OUT RPMB_RESPONSE_RESULT *ResponseResult
);
/**
This function programs the RPMB key into RPMB Partition.
@param[in] MediumType Current Medium Type option: eMMC, UFS, NVMe
@param[in] Lba The starting logical block address to be read/written.
The caller is responsible for reading/writing to only
legitimate locations.
@param[in] Key Input Key to check if programmed or not.
@param[in] KeySize Size of the Input Key.
@param[out] ResponseResult Output coming from the Response DataFrame.
@retval EFI_SUCCESS The operation is done correctly.
@retval Others The operation fails due to some error.
**/
EFI_STATUS
EFIAPI
RpmbProgramKey (
IN OS_BOOT_MEDIUM_TYPE MediumType,
IN EFI_LBA Lba,
IN CONST UINT8 *Key,
IN UINT8 KeySize,
OUT RPMB_RESPONSE_RESULT *ResponseResult
);
/**
This function writes to RPMB memory partition. Request Message Type is
Authenticated data write. If the MAC in the request message and the calculated MAC are
different, then this returns Authentication Failure. No data will be written.
@param[in] MediumType Current Medium Type option: eMMC, UFS, NVMe
@param[in] Lba The starting logical block address to be read/written.
The caller is responsible for reading/writing to only
legitimate locations.
@param[in] BlkCnt Number of RPMB_DATA_FRAME(s).
@param[in] BlkAddr Start address of the full packet.
@param[in] Buffer Data to be written. Should be a multiple of RPMB_BLOCK_SIZE.
@param[in] Key Input Key to calculate the MAC.
@param[in] KeySize Size of the Input Key.
@param[out] Result Output coming from the Response DataFrame.
@retval EFI_SUCCESS The operation is done correctly.
@retval Others The operation fails due to some error.
**/
EFI_STATUS
EFIAPI
RpmbWriteData (
IN OS_BOOT_MEDIUM_TYPE MediumType,
IN EFI_LBA Lba,
IN UINT8 BlkCnt,
IN UINT16 BlkAddr,
IN VOID *Buffer,
IN CONST UINT8 *Key,
IN UINT8 KeySize,
OUT RPMB_RESPONSE_RESULT *Result
);
/**
This function reads data from RPMB memory partition. Request Message Type is
Authenticated data read. If the MAC in the request message and the calculated MAC are
different, then this returns Authentication Failure. No data will be read back.
@param[in] MediumType Current Medium Type option: eMMC, UFS, NVMe
@param[in] Lba The starting logical block address to be read/written.
The caller is responsible for reading/writing to only
legitimate locations.
@param[in] BlkCount Number of RPMB_DATA_FRAME(s).
@param[in] BlkAddr Start address of the full packet.
@param[out] Buffer Data to be read back. Should be a multiple of RPMB_BLOCK_SIZE.
@param[in] Key Input Key to calculate the MAC.
@param[in] KeySize Size of the Input Key.
@param[out] Result This is the output coming from the Response DataFrame.
@retval EFI_SUCCESS The operation is done correctly.
@retval Others The operation fails due to some error.
**/
EFI_STATUS
EFIAPI
RpmbReadData (
IN OS_BOOT_MEDIUM_TYPE MediumType,
IN EFI_LBA Lba,
IN UINT8 BlkCount,
IN UINT16 BlkAddr,
OUT VOID *Buffer,
IN CONST UINT8 *Key,
IN UINT8 KeySize,
OUT RPMB_RESPONSE_RESULT *Result
);
#endif