]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/Guid/FileSystemInfo.h
MdePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdePkg / Include / Guid / FileSystemInfo.h
CommitLineData
c2f83f0a 1/** @file\r
25cfda03
LG
2 Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.GetInfo()\r
3 or EFI_FILE_PROTOCOL.SetInfo() to get or set information about the system's volume.\r
1a2f870c 4 This GUID is defined in UEFI specification.\r
c2f83f0a 5\r
9095d37b 6Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
9344f092 7SPDX-License-Identifier: BSD-2-Clause-Patent\r
c2f83f0a 8\r
c2f83f0a 9**/\r
10\r
11#ifndef __FILE_SYSTEM_INFO_H__\r
12#define __FILE_SYSTEM_INFO_H__\r
13\r
fd21d1aa 14#define EFI_FILE_SYSTEM_INFO_ID \\r
c2f83f0a 15 { \\r
16 0x9576e93, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
17 }\r
18\r
19typedef struct {\r
25cfda03 20 ///\r
af2dc6a7 21 /// The size of the EFI_FILE_SYSTEM_INFO structure, including the Null-terminated VolumeLabel string.\r
25cfda03 22 ///\r
c2f83f0a 23 UINT64 Size;\r
25cfda03
LG
24 ///\r
25 /// TRUE if the volume only supports read access.\r
26 ///\r
c2f83f0a 27 BOOLEAN ReadOnly;\r
25cfda03
LG
28 ///\r
29 /// The number of bytes managed by the file system.\r
30 ///\r
c2f83f0a 31 UINT64 VolumeSize;\r
25cfda03
LG
32 ///\r
33 /// The number of available bytes for use by the file system.\r
34 ///\r
c2f83f0a 35 UINT64 FreeSpace;\r
25cfda03
LG
36 ///\r
37 /// The nominal block size by which files are typically grown.\r
38 ///\r
c2f83f0a 39 UINT32 BlockSize;\r
25cfda03
LG
40 ///\r
41 /// The Null-terminated string that is the volume's label.\r
42 ///\r
c2f83f0a 43 CHAR16 VolumeLabel[1];\r
44} EFI_FILE_SYSTEM_INFO;\r
45\r
55d473ba 46///\r
47/// The VolumeLabel field of the EFI_FILE_SYSTEM_INFO data structure is variable length.\r
48/// Whenever code needs to know the size of the EFI_FILE_SYSTEM_INFO data structure, it needs\r
49/// to be the size of the data structure without the VolumeLable field. The following macro\r
50/// computes this size correctly no matter how big the VolumeLable array is declared.\r
51/// This is required to make the EFI_FILE_SYSTEM_INFO data structure ANSI compilant.\r
52///\r
07636730 53#define SIZE_OF_EFI_FILE_SYSTEM_INFO OFFSET_OF (EFI_FILE_SYSTEM_INFO, VolumeLabel)\r
c2f83f0a 54\r
55extern EFI_GUID gEfiFileSystemInfoGuid;\r
56\r
57#endif\r