fsp_fv.h 4.2 KB

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