]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdePkg/Include/Guid/FileInfo.h
MdePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdePkg / Include / Guid / FileInfo.h
... / ...
CommitLineData
1/** @file\r
2 Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.SetInfo()\r
3 and EFI_FILE_PROTOCOL.GetInfo() to set or get generic file information.\r
4 This GUID is defined in UEFI specification.\r
5\r
6Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
7SPDX-License-Identifier: BSD-2-Clause-Patent\r
8\r
9**/\r
10\r
11#ifndef __FILE_INFO_H__\r
12#define __FILE_INFO_H__\r
13\r
14#define EFI_FILE_INFO_ID \\r
15 { \\r
16 0x9576e92, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
17 }\r
18\r
19typedef struct {\r
20 ///\r
21 /// The size of the EFI_FILE_INFO structure, including the Null-terminated FileName string.\r
22 ///\r
23 UINT64 Size;\r
24 ///\r
25 /// The size of the file in bytes.\r
26 ///\r
27 UINT64 FileSize;\r
28 ///\r
29 /// PhysicalSize The amount of physical space the file consumes on the file system volume.\r
30 ///\r
31 UINT64 PhysicalSize;\r
32 ///\r
33 /// The time the file was created.\r
34 ///\r
35 EFI_TIME CreateTime;\r
36 ///\r
37 /// The time when the file was last accessed.\r
38 ///\r
39 EFI_TIME LastAccessTime;\r
40 ///\r
41 /// The time when the file's contents were last modified.\r
42 ///\r
43 EFI_TIME ModificationTime;\r
44 ///\r
45 /// The attribute bits for the file.\r
46 ///\r
47 UINT64 Attribute;\r
48 ///\r
49 /// The Null-terminated name of the file.\r
50 ///\r
51 CHAR16 FileName[1];\r
52} EFI_FILE_INFO;\r
53\r
54///\r
55/// The FileName field of the EFI_FILE_INFO data structure is variable length.\r
56/// Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to\r
57/// be the size of the data structure without the FileName field. The following macro\r
58/// computes this size correctly no matter how big the FileName array is declared.\r
59/// This is required to make the EFI_FILE_INFO data structure ANSI compilant.\r
60///\r
61#define SIZE_OF_EFI_FILE_INFO OFFSET_OF (EFI_FILE_INFO, FileName)\r
62\r
63extern EFI_GUID gEfiFileInfoGuid;\r
64\r
65#endif\r