]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /** @file\r |
2 | This file defines the data structures that comprise the FFS file system.\r | |
3 | \r | |
4 | Copyright (c) 2006, Intel Corporation \r | |
5 | All rights reserved. This program and the accompanying materials \r | |
6 | are licensed and made available under the terms and conditions of the BSD License \r | |
7 | which accompanies this distribution. The full text of the license may be found at \r | |
8 | http://opensource.org/licenses/bsd-license.php \r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
12 | \r | |
13 | Module Name: FirmwareFileSystem.h\r | |
14 | \r | |
15 | @par Revision Reference:\r | |
16 | These definitions are from Firmware File System Spec 0.9.\r | |
17 | \r | |
18 | **/\r | |
19 | \r | |
20 | #ifndef __EFI_FFS_FILE_SYSTEM_H__\r | |
21 | #define __EFI_FFS_FILE_SYSTEM_H__\r | |
22 | \r | |
23 | ///\r | |
24 | /// FFS specific file types\r | |
25 | ///\r | |
26 | #define EFI_FV_FILETYPE_FFS_PAD 0xF0\r | |
27 | \r | |
28 | //\r | |
29 | // FFS File Attributes\r | |
30 | //\r | |
31 | #define FFS_ATTRIB_TAIL_PRESENT 0x01\r | |
32 | #define FFS_ATTRIB_RECOVERY 0x02\r | |
33 | #define FFS_ATTRIB_HEADER_EXTENSION 0x04\r | |
34 | #define FFS_ATTRIB_DATA_ALIGNMENT 0x38\r | |
35 | #define FFS_ATTRIB_CHECKSUM 0x40\r | |
36 | \r | |
37 | ///\r | |
38 | /// FFS_FIXED_CHECKSUM is the default checksum value used when the\r | |
39 | /// FFS_ATTRIB_CHECKSUM attribute bit is clear\r | |
40 | /// note this is NOT an architecturally defined value, but is in this file for\r | |
41 | /// implementation convenience\r | |
42 | ///\r | |
43 | #define FFS_FIXED_CHECKSUM 0x5A\r | |
44 | \r | |
45 | //\r | |
46 | // File state definitions\r | |
47 | //\r | |
48 | #define EFI_FILE_HEADER_CONSTRUCTION 0x01\r | |
49 | #define EFI_FILE_HEADER_VALID 0x02\r | |
50 | #define EFI_FILE_DATA_VALID 0x04\r | |
51 | #define EFI_FILE_MARKED_FOR_UPDATE 0x08\r | |
52 | #define EFI_FILE_DELETED 0x10\r | |
53 | #define EFI_FILE_HEADER_INVALID 0x20\r | |
54 | \r | |
55 | #define EFI_FILE_ALL_STATE_BITS (EFI_FILE_HEADER_CONSTRUCTION | \\r | |
56 | EFI_FILE_HEADER_VALID | \\r | |
57 | EFI_FILE_DATA_VALID | \\r | |
58 | EFI_FILE_MARKED_FOR_UPDATE | \\r | |
59 | EFI_FILE_DELETED | \\r | |
60 | EFI_FILE_HEADER_INVALID \\r | |
61 | )\r | |
62 | \r | |
878ddf1f | 63 | typedef UINT16 EFI_FFS_FILE_TAIL;\r |
64 | \r | |
65 | ///\r | |
66 | /// FFS file integrity check structure\r | |
67 | ///\r | |
68 | typedef union {\r | |
69 | struct {\r | |
70 | UINT8 Header;\r | |
71 | UINT8 File;\r | |
72 | } Checksum;\r | |
73 | UINT16 TailReference;\r | |
74 | } EFI_FFS_INTEGRITY_CHECK;\r | |
75 | \r | |
76 | //\r | |
77 | // FFS file header definition\r | |
78 | //\r | |
79 | typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;\r | |
80 | typedef UINT8 EFI_FFS_FILE_STATE;\r | |
81 | \r | |
82 | typedef struct {\r | |
83 | EFI_GUID Name;\r | |
84 | EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r | |
85 | EFI_FV_FILETYPE Type;\r | |
86 | EFI_FFS_FILE_ATTRIBUTES Attributes;\r | |
87 | UINT8 Size[3];\r | |
88 | EFI_FFS_FILE_STATE State;\r | |
89 | } EFI_FFS_FILE_HEADER;\r | |
90 | \r | |
91 | #endif\r |