arch/x86/include/asm/fsp/fsp_fv.h

   1 /* SPDX-License-Identifier: Intel */
   2 /*
   3  * Copyright (C) 2013, Intel Corporation
   4  * Copyright (C) 2014, Bin Meng <bmeng.cn@gmail.com>
   5  */
   6
   7 #ifndef __FSP_FV___
   8 #define __FSP_FV___
   9
  10 #include <efi.h>
  11
  12 /* Value of EFI_FV_FILE_ATTRIBUTES */
  13 #define EFI_FV_FILE_ATTR_ALIGNMENT      0x0000001F
  14 #define EFI_FV_FILE_ATTR_FIXED          0x00000100
  15 #define EFI_FV_FILE_ATTR_MEMORY_MAPPED  0x00000200
  16
  17 /* Attributes bit definitions */
  18 #define EFI_FVB2_READ_DISABLED_CAP      0x00000001
  19 #define EFI_FVB2_READ_ENABLED_CAP       0x00000002
  20 #define EFI_FVB2_READ_STATUS            0x00000004
  21 #define EFI_FVB2_WRITE_DISABLED_CAP     0x00000008
  22 #define EFI_FVB2_WRITE_ENABLED_CAP      0x00000010
  23 #define EFI_FVB2_WRITE_STATUS           0x00000020
  24 #define EFI_FVB2_LOCK_CAP               0x00000040
  25 #define EFI_FVB2_LOCK_STATUS            0x00000080
  26 #define EFI_FVB2_STICKY_WRITE           0x00000200
  27 #define EFI_FVB2_MEMORY_MAPPED          0x00000400
  28 #define EFI_FVB2_ERASE_POLARITY         0x00000800
  29 #define EFI_FVB2_READ_LOCK_CAP          0x00001000
  30 #define EFI_FVB2_READ_LOCK_STATUS       0x00002000
  31 #define EFI_FVB2_WRITE_LOCK_CAP         0x00004000
  32 #define EFI_FVB2_WRITE_LOCK_STATUS      0x00008000
  33 #define EFI_FVB2_ALIGNMENT              0x001F0000
  34 #define EFI_FVB2_ALIGNMENT_1            0x00000000
  35 #define EFI_FVB2_ALIGNMENT_2            0x00010000
  36 #define EFI_FVB2_ALIGNMENT_4            0x00020000
  37 #define EFI_FVB2_ALIGNMENT_8            0x00030000
  38 #define EFI_FVB2_ALIGNMENT_16           0x00040000
  39 #define EFI_FVB2_ALIGNMENT_32           0x00050000
  40 #define EFI_FVB2_ALIGNMENT_64           0x00060000
  41 #define EFI_FVB2_ALIGNMENT_128          0x00070000
  42 #define EFI_FVB2_ALIGNMENT_256          0x00080000
  43 #define EFI_FVB2_ALIGNMENT_512          0x00090000
  44 #define EFI_FVB2_ALIGNMENT_1K           0x000A0000
  45 #define EFI_FVB2_ALIGNMENT_2K           0x000B0000
  46 #define EFI_FVB2_ALIGNMENT_4K           0x000C0000
  47 #define EFI_FVB2_ALIGNMENT_8K           0x000D0000
  48 #define EFI_FVB2_ALIGNMENT_16K          0x000E0000
  49 #define EFI_FVB2_ALIGNMENT_32K          0x000F0000
  50 #define EFI_FVB2_ALIGNMENT_64K          0x00100000
  51 #define EFI_FVB2_ALIGNMENT_128K         0x00110000
  52 #define EFI_FVB2_ALIGNMENT_256K         0x00120000
  53 #define EFI_FVB2_ALIGNMENT_512K         0x00130000
  54 #define EFI_FVB2_ALIGNMENT_1M           0x00140000
  55 #define EFI_FVB2_ALIGNMENT_2M           0x00150000
  56 #define EFI_FVB2_ALIGNMENT_4M           0x00160000
  57 #define EFI_FVB2_ALIGNMENT_8M           0x00170000
  58 #define EFI_FVB2_ALIGNMENT_16M          0x00180000
  59 #define EFI_FVB2_ALIGNMENT_32M          0x00190000
  60 #define EFI_FVB2_ALIGNMENT_64M          0x001A0000
  61 #define EFI_FVB2_ALIGNMENT_128M         0x001B0000
  62 #define EFI_FVB2_ALIGNMENT_256M         0x001C0000
  63 #define EFI_FVB2_ALIGNMENT_512M         0x001D0000
  64 #define EFI_FVB2_ALIGNMENT_1G           0x001E0000
  65 #define EFI_FVB2_ALIGNMENT_2G           0x001F0000
  66
  67 struct fv_blkmap_entry {
  68         /* The number of sequential blocks which are of the same size */
  69         u32     num_blocks;
  70         /* The size of the blocks */
  71         u32     length;
  72 };
  73
  74 /* Describes the features and layout of the firmware volume */
  75 struct fv_header {
  76         /*
  77          * The first 16 bytes are reserved to allow for the reset vector of
  78          * processors whose reset vector is at address 0.
  79          */
  80         u8                      zero_vec[16];
  81         /*
  82          * Declares the file system with which the firmware volume
  83          * is formatted.
  84          */
  85         efi_guid_t              fs_guid;
  86         /*
  87          * Length in bytes of the complete firmware volume, including
  88          * the header.
  89          */
  90         u64                     fv_len;
  91         /* Set to EFI_FVH_SIGNATURE */
  92         u32                     sign;
  93         /*
  94          * Declares capabilities and power-on defaults for the firmware
  95          * volume.
  96          */
  97         u32                     attr;
  98         /* Length in bytes of the complete firmware volume header */
  99         u16                     hdr_len;
 100         /*
 101          * A 16-bit checksum of the firmware volume header.
 102          * A valid header sums to zero.
 103          */
 104         u16                     checksum;
 105         /*
 106          * Offset, relative to the start of the header, of the extended
 107          * header (EFI_FIRMWARE_VOLUME_EXT_HEADER) or zero if there is
 108          * no extended header.
 109          */
 110         u16                     ext_hdr_off;
 111         /* This field must always be set to zero */
 112         u8                      reserved[1];
 113         /*
 114          * Set to 2. Future versions of this specification may define new
 115          * header fields and will increment the Revision field accordingly.
 116          */
 117         u8                      rev;
 118         /*
 119          * An array of run-length encoded FvBlockMapEntry structures.
 120          * The array is terminated with an entry of {0,0}.
 121          */
 122         struct fv_blkmap_entry  block_map[1];
 123 };
 124
 125 #define EFI_FVH_SIGNATURE       SIGNATURE_32('_', 'F', 'V', 'H')
 126
 127 /* Firmware Volume Header Revision definition */
 128 #define EFI_FVH_REVISION        0x02
 129
 130 /* Extension header pointed by ExtHeaderOffset of volume header */
 131 struct fv_ext_header {
 132         /* firmware volume name */
 133         efi_guid_t              fv_name;
 134         /* Size of the rest of the extension header including this structure */
 135         u32                     ext_hdr_size;
 136 };
 137
 138 #endif