Files
slimbootloader/BootloaderCommonPkg/Library/LiteVariableLib/VariableFormat.h
T
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

87 lines
1.9 KiB
C

/** @file
The variable data structures.
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef __VARIABLE_FORMAT_H__
#define __VARIABLE_FORMAT_H__
#define VARIABLE_STORE_SIZE FixedPcdGet32(PcdVariableStoreSize)
#define VARIABLE_STORE_SIGNATURE SIGNATURE_32('V', 'A', 'R', 'S')
#define VARIABLE_NAME_MAX_LEN 64
///
/// Variable data start flag.
///
#define VARIABLE_DATA 0xA5
///
/// Variable State flags.
///
#define VAR_HEADER_VALID 0x01
#define VAR_DATA_VALID 0x02
#define VAR_IN_MIGRATION 0x04
#define VAR_DELETED 0x08
///
/// Variable Attribute combinations.
///
#define VAR_ATTR_READ_ONLY 0x10
///
/// Variable state macros
///
#define IS_HEADER_VALID(State) (((State) & VAR_HEADER_VALID) == 0)
#define IS_DATA_VALID(State) (((State) & VAR_DATA_VALID) == 0)
#define IS_IN_MIGRATION(State) (((State) & VAR_IN_MIGRATION) == 0)
#define IS_DELETED(State) (((State) & VAR_DELETED) == 0)
///
/// Variable Store region header.
///
typedef struct {
///
/// Variable store region signature.
///
UINT32 Signature;
///
/// Size of entire variable store,
/// including size of variable store header but not including the size of FvHeader.
///
UINT32 Size;
///
/// Variable region format state.
///
UINT8 Format;
///
/// Variable region healthy state.
///
UINT8 State;
UINT8 Reserved[6];
} VARIABLE_STORE_HEADER;
///
/// Single Variable Data Header Structure.
///
typedef struct {
///
/// Variable Data Start Flag.
///
UINT8 StartId;
///
/// Variable State defined above.
///
UINT8 State;
///
/// Size of the variable data.
///
UINT16 DataSize;
} VARIABLE_HEADER;
#endif