IntelFrameworkPkg/Include/Framework/FirmwareVolumeHeader.h

   1 /** @file
   2   Defines the data structure that is the volume header found at the beginning of
   3   all firmware volumes that are either memory mapped or have an
   4   associated FirmwareVolumeBlock protocol.
   5
   6 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   7 SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9   @par Revision Reference:
  10   These definitions are from the Firmware Volume Block Spec 0.9.
  11
  12 **/
  13
  14 #ifndef __EFI_FIRMWARE_VOLUME_HEADER_H__
  15 #define __EFI_FIRMWARE_VOLUME_HEADER_H__
  16
  17 ///
  18 /// Firmware Volume Block Attributes bit definitions.
  19 ///@{
  20 #define EFI_FVB_READ_DISABLED_CAP   0x00000001
  21 #define EFI_FVB_READ_ENABLED_CAP    0x00000002
  22 #define EFI_FVB_READ_STATUS         0x00000004
  23
  24 #define EFI_FVB_WRITE_DISABLED_CAP  0x00000008
  25 #define EFI_FVB_WRITE_ENABLED_CAP   0x00000010
  26 #define EFI_FVB_WRITE_STATUS        0x00000020
  27
  28 #define EFI_FVB_LOCK_CAP            0x00000040
  29 #define EFI_FVB_LOCK_STATUS         0x00000080
  30
  31 #define EFI_FVB_STICKY_WRITE        0x00000200
  32 #define EFI_FVB_MEMORY_MAPPED       0x00000400
  33 #define EFI_FVB_ERASE_POLARITY      0x00000800
  34
  35 #define EFI_FVB_ALIGNMENT_CAP       0x00008000
  36 #define EFI_FVB_ALIGNMENT_2         0x00010000
  37 #define EFI_FVB_ALIGNMENT_4         0x00020000
  38 #define EFI_FVB_ALIGNMENT_8         0x00040000
  39 #define EFI_FVB_ALIGNMENT_16        0x00080000
  40 #define EFI_FVB_ALIGNMENT_32        0x00100000
  41 #define EFI_FVB_ALIGNMENT_64        0x00200000
  42 #define EFI_FVB_ALIGNMENT_128       0x00400000
  43 #define EFI_FVB_ALIGNMENT_256       0x00800000
  44 #define EFI_FVB_ALIGNMENT_512       0x01000000
  45 #define EFI_FVB_ALIGNMENT_1K        0x02000000
  46 #define EFI_FVB_ALIGNMENT_2K        0x04000000
  47 #define EFI_FVB_ALIGNMENT_4K        0x08000000
  48 #define EFI_FVB_ALIGNMENT_8K        0x10000000
  49 #define EFI_FVB_ALIGNMENT_16K       0x20000000
  50 #define EFI_FVB_ALIGNMENT_32K       0x40000000
  51 #define EFI_FVB_ALIGNMENT_64K       0x80000000
  52 ///@}
  53
  54 /// This is a simple macro defined as the set of all FV Block Attributes signifying capabilities.
  55 #define EFI_FVB_CAPABILITIES  ( EFI_FVB_READ_DISABLED_CAP  | \
  56                                 EFI_FVB_READ_ENABLED_CAP   | \
  57                                 EFI_FVB_WRITE_DISABLED_CAP | \
  58                                 EFI_FVB_WRITE_ENABLED_CAP  | \
  59                                 EFI_FVB_LOCK_CAP \
  60                               )
  61
  62 /** A parameterized macro defining a boolean expression that tests the state of a particular bit.
  63   *
  64   * @param FvbAttributes  Indicates a test for CLEAR if EFI_FVB_ERASE_POLARITY is 1, else test for SET.
  65   *
  66   * @param TestAttributes The set of bits to test.
  67   *
  68   * @param Bit            A value indicating the bit(s) to test.
  69   *                       If multiple bits are set, the logical OR of their tests is the expression's value.
  70 **/
  71 #define EFI_TEST_FFS_ATTRIBUTES_BIT( FvbAttributes, TestAttributes, Bit) \
  72     ((BOOLEAN) \
  73       ((FvbAttributes & EFI_FVB_ERASE_POLARITY) ? (((~TestAttributes) & Bit) == Bit) : ((TestAttributes & Bit) == Bit)) \
  74     )
  75
  76 /// A simple macro defined as the set of all FV Block Attribute bits that indicate status.
  77 #define EFI_FVB_STATUS    (EFI_FVB_READ_STATUS | EFI_FVB_WRITE_STATUS | EFI_FVB_LOCK_STATUS)
  78
  79 #endif  /* __EFI_FIRMWARE_VOLUME_HEADER_H__ */