MdePkg/Include/Guid/FileSystemInfo.h

   1 /** @file
   2   Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.GetInfo()
   3   or EFI_FILE_PROTOCOL.SetInfo() to get or set information about the system's volume.
   4   This GUID is defined in UEFI specification.
   5
   6 Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>
   7 This program and the accompanying materials are licensed and made available under
   8 the terms and conditions of the BSD License that accompanies this distribution.
   9 The full text of the license may be found at
  10 http://opensource.org/licenses/bsd-license.php.
  11
  12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef __FILE_SYSTEM_INFO_H__
  18 #define __FILE_SYSTEM_INFO_H__
  19
  20 #define EFI_FILE_SYSTEM_INFO_ID \
  21   { \
  22     0x9576e93, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  23   }
  24
  25 typedef struct {
  26   ///
  27   /// The size of the EFI_FILE_SYSTEM_INFO structure, including the Null-terminated VolumeLabel string.
  28   ///
  29   UINT64  Size;
  30   ///
  31   /// TRUE if the volume only supports read access.
  32   ///
  33   BOOLEAN ReadOnly;
  34   ///
  35   /// The number of bytes managed by the file system.
  36   ///
  37   UINT64  VolumeSize;
  38   ///
  39   /// The number of available bytes for use by the file system.
  40   ///
  41   UINT64  FreeSpace;
  42   ///
  43   /// The nominal block size by which files are typically grown.
  44   ///
  45   UINT32  BlockSize;
  46   ///
  47   /// The Null-terminated string that is the volume's label.
  48   ///
  49   CHAR16  VolumeLabel[1];
  50 } EFI_FILE_SYSTEM_INFO;
  51
  52 ///
  53 /// The VolumeLabel field of the EFI_FILE_SYSTEM_INFO data structure is variable length.
  54 /// Whenever code needs to know the size of the EFI_FILE_SYSTEM_INFO data structure, it needs
  55 /// to be the size of the data structure without the VolumeLable field.  The following macro
  56 /// computes this size correctly no matter how big the VolumeLable array is declared.
  57 /// This is required to make the EFI_FILE_SYSTEM_INFO data structure ANSI compilant.
  58 ///
  59 #define SIZE_OF_EFI_FILE_SYSTEM_INFO  OFFSET_OF (EFI_FILE_SYSTEM_INFO, VolumeLabel)
  60
  61 extern EFI_GUID gEfiFileSystemInfoGuid;
  62
  63 #endif