Files
slimbootloader/BootloaderCommonPkg/Include/Library/FileSystemLib.h
T
Guo Dong 501be46716 Update file system support
The patch gives the platform the configuration capability to only build
required file system into final image.
This helps to have a smaller image for fast boot.

Signed-off-by: Guo Dong <guo.dong@intel.com>
2018-11-27 15:09:14 -07:00

125 lines
4.3 KiB
C

/** @file
File system level API library interface prototypes
Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available
under the terms and conditions of the BSD License which accompanies this
distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _FILE_SYSTEM_LIB_H_
#define _FILE_SYSTEM_LIB_H_
#include <Library/PartitionLib.h>
#include <Library/FatLib.h>
#include <Library/Ext23Lib.h>
#include <Guid/OsBootOptionGuid.h>
/**
Loads file into memory by its name.
@param[in] FsHandle FAT file system handle.
@param[in] FileName The file name to get.
@param[out] FileBufferPtr Allocated file buffer pointer.
@param[out] FileSize Pointer to file buffer size.
@retval EFI_SUCCESS The file was loaded correctly.
@retval EFI_INVALID_PARAMETER Parameter is not valid.
@retval EFI_DEVICE_ERROR A device error occurred.
@retval EFI_NOT_FOUND A requested file cannot be found.
@retval EFI_OUT_OF_RESOURCES Insufficant memory resource pool.
@retval EFI_BUFFER_TOO_SMALL Buffer size is too small.
**/
EFI_STATUS
EFIAPI
GetFileByName (
IN EFI_HANDLE FsHandle,
IN CHAR16 *FileName,
OUT VOID **FileBuffer,
OUT UINTN *FileSize
);
/**
Initialize file systems.
@param[in] SwPart Software partition index.
@param[in] FsType Filesystem type.
@param[in] PartHandle Partition handle.
@param[out] FsHandle FAT file system handle.
@retval EFI_SUCCESS The file system was initialized successfully.
@retval EFI_INVALID_PARAMETER Parameter is not valid.
@retval EFI_NOT_FOUND FAT file system was not detected on this partition.
@retval EFI_OUT_OF_RESOURCES Insufficant memory resource pool.
**/
EFI_STATUS
EFIAPI
InitFileSystem (
IN UINT32 SwPart,
IN UINT32 FsType,
IN EFI_HANDLE PartHandle,
OUT EFI_HANDLE *FsHandle
);
/**
Loads file into memory by its name.
@param[in] FsHandle FAT file system handle.
@param[in] FileName The file name to get.
@param[out] FileBufferPtr Allocated file buffer pointer.
@param[out] FileSize Pointer to file buffer size.
@retval EFI_SUCCESS The file was loaded correctly.
@retval EFI_INVALID_PARAMETER Parameter is not valid.
@retval EFI_DEVICE_ERROR A device error occurred.
@retval EFI_NOT_FOUND A requested file cannot be found.
@retval EFI_OUT_OF_RESOURCES Insufficant memory resource pool.
@retval EFI_BUFFER_TOO_SMALL Buffer size is too small.
**/
typedef
EFI_STATUS
(EFIAPI *FS_GET_FILE_BY_NAME) (
IN EFI_HANDLE FsHandle,
IN CHAR16 *FileName,
OUT VOID **FileBuffer,
OUT UINTN *FileSize
);
/**
Initialize file systems.
@param[in] SwPart Software partition index.
@param[in] PartHandle Partition handle.
@param[out] FsHandle FAT file system handle.
@retval EFI_SUCCESS The file system was initialized successfully.
@retval EFI_INVALID_PARAMETER Parameter is not valid.
@retval EFI_NOT_FOUND FAT file system was not detected on this partition.
@retval EFI_OUT_OF_RESOURCES Insufficant memory resource pool.
**/
typedef
EFI_STATUS
(EFIAPI *FS_INITIALIZE) (
IN UINT32 SwPart,
IN EFI_HANDLE PartHandle,
OUT EFI_HANDLE *FsHandle
);
typedef struct {
FS_INITIALIZE InitFileSystem;
FS_GET_FILE_BY_NAME GetFileByName;
} FILE_SYSTEM_FUNC;
#endif // _FAT_PEIM_H_