[mirror_edk2.git] / FatPkg / FatPei / FatLitePeim.h

/** @file\r
  Data structures for FAT recovery PEIM\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
This program and the accompanying materials are licensed and made available\r
under the terms and conditions of the BSD License which accompanies this\r
distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _FAT_PEIM_H_\r
#define _FAT_PEIM_H_\r
\r
#include <PiPei.h>\r
\r
#include <Guid/RecoveryDevice.h>\r
#include <Ppi/BlockIo.h>\r
#include <Ppi/BlockIo2.h>\r
#include <Ppi/DeviceRecoveryModule.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/PeimEntryPoint.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/PeiServicesLib.h>\r
\r
#include "FatLiteApi.h"\r
#include "FatLiteFmt.h"\r
\r
//\r
// Definitions\r
//\r
\r
#define PEI_FAT_CACHE_SIZE                            4\r
#define PEI_FAT_MAX_BLOCK_SIZE                        8192\r
#define FAT_MAX_FILE_NAME_LENGTH                      128\r
#define PEI_FAT_MAX_BLOCK_DEVICE                      64\r
#define PEI_FAT_MAX_BLOCK_IO_PPI                      32\r
#define PEI_FAT_MAX_VOLUME                            64\r
\r
#define PEI_FAT_MEMMORY_PAGE_SIZE                     0x1000\r
\r
//\r
// Data Structures\r
//\r
//\r
// The block device\r
//\r
typedef struct {\r
\r
  UINT32                        BlockSize;\r
  UINT64                        LastBlock;\r
  UINT32                        IoAlign;\r
  BOOLEAN                       Logical;\r
  BOOLEAN                       PartitionChecked;\r
\r
  //\r
  // Following fields only valid for logical device\r
  //\r
  CHAR8                         PartitionFlag[8];\r
  UINT64                        StartingPos;\r
  UINTN                         ParentDevNo;\r
\r
  //\r
  // Following fields only valid for physical device\r
  //\r
  EFI_PEI_BLOCK_DEVICE_TYPE     DevType;\r
  UINT8                         InterfaceType;\r
  //\r
  // EFI_PEI_READ_BLOCKS         ReadFunc;\r
  //\r
  EFI_PEI_RECOVERY_BLOCK_IO_PPI  *BlockIo;\r
  EFI_PEI_RECOVERY_BLOCK_IO2_PPI *BlockIo2;\r
  UINT8                          PhysicalDevNo;\r
} PEI_FAT_BLOCK_DEVICE;\r
\r
//\r
// the Volume structure\r
//\r
typedef struct {\r
\r
  UINTN         BlockDeviceNo;\r
  UINTN         VolumeNo;\r
  UINT64        VolumeSize;\r
  UINTN         MaxCluster;\r
  CHAR16        VolumeLabel[FAT_MAX_FILE_NAME_LENGTH];\r
  PEI_FAT_TYPE  FatType;\r
  UINT64        FatPos;\r
  UINT32        SectorSize;\r
  UINT32        ClusterSize;\r
  UINT64        FirstClusterPos;\r
  UINT64        RootDirPos;\r
  UINT32        RootEntries;\r
  UINT32        RootDirCluster;\r
\r
} PEI_FAT_VOLUME;\r
\r
//\r
// File instance\r
//\r
typedef struct {\r
\r
  PEI_FAT_VOLUME  *Volume;\r
  CHAR16          FileName[FAT_MAX_FILE_NAME_LENGTH];\r
\r
  BOOLEAN         IsFixedRootDir;\r
\r
  UINT32          StartingCluster;\r
  UINT32          CurrentPos;\r
  UINT32          StraightReadAmount;\r
  UINT32          CurrentCluster;\r
\r
  UINT8           Attributes;\r
  UINT32          FileSize;\r
\r
} PEI_FAT_FILE;\r
\r
//\r
// Cache Buffer\r
//\r
typedef struct {\r
\r
  BOOLEAN Valid;\r
  UINTN   BlockDeviceNo;\r
  UINT64  Lba;\r
  UINT32  Lru;\r
  UINT64  Buffer[PEI_FAT_MAX_BLOCK_SIZE / 8];\r
  UINTN   Size;\r
\r
} PEI_FAT_CACHE_BUFFER;\r
\r
//\r
// Private Data.\r
// This structure abstracts the whole memory usage in FAT PEIM.\r
// The entry point routine will get a chunk of memory (by whatever\r
// means) whose size is sizeof(PEI_FAT_PRIVATE_DATA), which is clean\r
// in both 32 and 64 bit environment. The boundary of the memory chunk\r
// should be 64bit aligned.\r
//\r
#define PEI_FAT_PRIVATE_DATA_SIGNATURE  SIGNATURE_32 ('p', 'f', 'a', 't')\r
\r
typedef struct {\r
\r
  UINTN                               Signature;\r
  EFI_PEI_DEVICE_RECOVERY_MODULE_PPI  DeviceRecoveryPpi;\r
  EFI_PEI_PPI_DESCRIPTOR              PpiDescriptor;\r
  EFI_PEI_NOTIFY_DESCRIPTOR           NotifyDescriptor[2];\r
\r
  UINT8                               UnicodeCaseMap[0x300];\r
  CHAR8                               *EngUpperMap;\r
  CHAR8                               *EngLowerMap;\r
  CHAR8                               *EngInfoMap;\r
\r
  UINT64                              BlockData[PEI_FAT_MAX_BLOCK_SIZE / 8];\r
  UINTN                               BlockDeviceCount;\r
  PEI_FAT_BLOCK_DEVICE                BlockDevice[PEI_FAT_MAX_BLOCK_DEVICE];\r
  UINTN                               VolumeCount;\r
  PEI_FAT_VOLUME                      Volume[PEI_FAT_MAX_VOLUME];\r
  PEI_FAT_FILE                        File;\r
  PEI_FAT_CACHE_BUFFER                CacheBuffer[PEI_FAT_CACHE_SIZE];\r
\r
} PEI_FAT_PRIVATE_DATA;\r
\r
#define PEI_FAT_PRIVATE_DATA_FROM_THIS(a) \\r
  CR (a,  PEI_FAT_PRIVATE_DATA, DeviceRecoveryPpi, PEI_FAT_PRIVATE_DATA_SIGNATURE)\r
\r
//\r
// Extract INT32 from char array\r
//\r
#define UNPACK_INT32(a) \\r
  (INT32) ((((UINT8 *) a)[0] << 0) | (((UINT8 *) a)[1] << 8) | (((UINT8 *) a)[2] << 16) | (((UINT8 *) a)[3] << 24))\r
\r
//\r
// Extract UINT32 from char array\r
//\r
#define UNPACK_UINT32(a) \\r
  (UINT32) ((((UINT8 *) a)[0] << 0) | (((UINT8 *) a)[1] << 8) | (((UINT8 *) a)[2] << 16) | (((UINT8 *) a)[3] << 24))\r
\r
\r
//\r
// API functions\r
//\r
\r
/**\r
  Finds the recovery file on a FAT volume.\r
  This function finds the the recovery file named FileName on a specified FAT volume and returns\r
  its FileHandle pointer.\r
\r
  @param  PrivateData             Global memory map for accessing global\r
                                  variables.\r
  @param  VolumeIndex             The index of the volume.\r
  @param  FileName                The recovery file name to find.\r
  @param  Handle                  The output file handle.\r
\r
  @retval EFI_DEVICE_ERROR        Some error occured when operating the FAT\r
                                  volume.\r
  @retval EFI_NOT_FOUND           The recovery file was not found.\r
  @retval EFI_SUCCESS             The recovery file was successfully found on the\r
                                  FAT volume.\r
\r
**/\r
EFI_STATUS\r
FindRecoveryFile (\r
  IN  PEI_FAT_PRIVATE_DATA  *PrivateData,\r
  IN  UINTN                 VolumeIndex,\r
  IN  CHAR16                *FileName,\r
  OUT PEI_FILE_HANDLE       *Handle\r
  );\r
\r
\r
/**\r
  Returns the number of DXE capsules residing on the device.\r
  This function, by whatever mechanism, searches for DXE capsules from the associated device and\r
  returns the number and maximum size in bytes of the capsules discovered.Entry 1 is assumed to be\r
  the highest load priority and entry N is assumed to be the lowest priority.\r
\r
  @param  PeiServices             General-purpose services that are available to\r
                                  every PEIM.\r
  @param  This                    Indicates the\r
                                  EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
  @param  NumberRecoveryCapsules  Pointer to a caller-allocated UINTN.On output,\r
                                  *NumberRecoveryCapsules contains the number of\r
                                  recovery capsule images available for retrieval\r
                                  from this PEIM instance.\r
\r
  @retval EFI_SUCCESS             The function completed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetNumberRecoveryCapsules (\r
  IN EFI_PEI_SERVICES                               **PeiServices,\r
  IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI             *This,\r
  OUT UINTN                                         *NumberRecoveryCapsules\r
  );\r
\r
\r
/**\r
  Returns the size and type of the requested recovery capsule.\r
  This function returns the size and type of the capsule specified by CapsuleInstance.\r
\r
  @param  PeiServices             General-purpose services that are available to\r
                                  every PEIM.\r
  @param  This                    Indicates the\r
                                  EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
  @param  CapsuleInstance         Specifies for which capsule instance to\r
                                  retrieve the information.T his parameter must\r
                                  be between one and the value returned by\r
                                  GetNumberRecoveryCapsules() in\r
                                  NumberRecoveryCapsules.\r
  @param  Size                    A pointer to a caller-allocated UINTN in which\r
                                  the size of the requested recovery module is\r
                                  returned.\r
  @param  CapsuleType             A pointer to a caller-allocated EFI_GUID in\r
                                  which the type of the requested recovery\r
                                  capsule is returned.T he semantic meaning of\r
                                  the value returned is defined by the\r
                                  implementation.\r
\r
  @retval EFI_SUCCESS             The capsule type and size were retrieved.\r
  @retval EFI_INVALID_PARAMETER   The input CapsuleInstance does not match any\r
                                  discovered recovery capsule.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetRecoveryCapsuleInfo (\r
  IN  EFI_PEI_SERVICES                              **PeiServices,\r
  IN  EFI_PEI_DEVICE_RECOVERY_MODULE_PPI            *This,\r
  IN  UINTN                                         CapsuleInstance,\r
  OUT UINTN                                         *Size,\r
  OUT EFI_GUID                                      *CapsuleType\r
  );\r
\r
\r
/**\r
  Loads a DXE capsule from some media into memory.\r
\r
  This function, by whatever mechanism, retrieves a DXE capsule from some device\r
  and loads it into memory. Note that the published interface is device neutral.\r
\r
  @param[in]     PeiServices       General-purpose services that are available\r
                                   to every PEIM\r
  @param[in]     This              Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI\r
                                   instance.\r
  @param[in]     CapsuleInstance   Specifies which capsule instance to retrieve.\r
  @param[out]    Buffer            Specifies a caller-allocated buffer in which\r
                                   the requested recovery capsule will be returned.\r
\r
  @retval EFI_SUCCESS        The capsule was loaded correctly.\r
  @retval EFI_DEVICE_ERROR   A device error occurred.\r
  @retval EFI_NOT_FOUND      A requested recovery DXE capsule cannot be found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LoadRecoveryCapsule (\r
  IN EFI_PEI_SERVICES                             **PeiServices,\r
  IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI           *This,\r
  IN UINTN                                        CapsuleInstance,\r
  OUT VOID                                        *Buffer\r
  );\r
\r
\r
/**\r
  This version is different from the version in Unicode collation\r
  protocol in that this version strips off trailing blanks.\r
  Converts an 8.3 FAT file name using an OEM character set\r
  to a Null-terminated Unicode string.\r
  Here does not expand DBCS FAT chars.\r
\r
  @param  FatSize           The size of the string Fat in bytes.\r
  @param  Fat               A pointer to a Null-terminated string that contains\r
                            an 8.3 file name using an OEM character set.\r
  @param  Str               A pointer to a Null-terminated Unicode string. The\r
                            string must be allocated in advance to hold FatSize\r
                            Unicode characters\r
\r
**/\r
VOID\r
EngFatToStr (\r
  IN UINTN                            FatSize,\r
  IN CHAR8                            *Fat,\r
  OUT CHAR16                          *Str\r
  );\r
\r
\r
/**\r
  Performs a case-insensitive comparison of two Null-terminated Unicode strings.\r
\r
  @param  PrivateData       Global memory map for accessing global variables\r
  @param  Str1              First string to perform case insensitive comparison.\r
  @param  Str2              Second string to perform case insensitive comparison.\r
\r
**/\r
BOOLEAN\r
EngStriColl (\r
  IN  PEI_FAT_PRIVATE_DATA  *PrivateData,\r
  IN CHAR16                 *Str1,\r
  IN CHAR16                 *Str2\r
  );\r
\r
\r
/**\r
  Reads a block of data from the block device by calling\r
  underlying Block I/O service.\r
\r
  @param  PrivateData       Global memory map for accessing global variables\r
  @param  BlockDeviceNo     The index for the block device number.\r
  @param  Lba               The logic block address to read data from.\r
  @param  BufferSize        The size of data in byte to read.\r
  @param  Buffer            The buffer of the\r
\r
  @retval EFI_DEVICE_ERROR  The specified block device number exceeds the maximum\r
                            device number.\r
  @retval EFI_DEVICE_ERROR  The maximum address has exceeded the maximum address\r
                            of the block device.\r
\r
**/\r
EFI_STATUS\r
FatReadBlock (\r
  IN  PEI_FAT_PRIVATE_DATA   *PrivateData,\r
  IN  UINTN                  BlockDeviceNo,\r
  IN  EFI_PEI_LBA            Lba,\r
  IN  UINTN                  BufferSize,\r
  OUT VOID                   *Buffer\r
  );\r
\r
\r
/**\r
  Check if there is a valid FAT in the corresponding Block device\r
  of the volume and if yes, fill in the relevant fields for the\r
  volume structure. Note there should be a valid Block device number\r
  already set.\r
\r
  @param  PrivateData            Global memory map for accessing global\r
                                 variables.\r
  @param  Volume                 On input, the BlockDeviceNumber field of the\r
                                 Volume  should be a valid value. On successful\r
                                 output, all  fields except the VolumeNumber\r
                                 field is initialized.\r
\r
  @retval EFI_SUCCESS            A FAT is found and the volume structure is\r
                                 initialized.\r
  @retval EFI_NOT_FOUND          There is no FAT on the corresponding device.\r
  @retval EFI_DEVICE_ERROR       There is something error while accessing device.\r
\r
**/\r
EFI_STATUS\r
FatGetBpbInfo (\r
  IN      PEI_FAT_PRIVATE_DATA  *PrivateData,\r
  IN OUT  PEI_FAT_VOLUME        *Volume\r
  );\r
\r
\r
/**\r
  Gets the next cluster in the cluster chain.\r
\r
  @param  PrivateData            Global memory map for accessing global variables\r
  @param  Volume                 The volume\r
  @param  Cluster                The cluster\r
  @param  NextCluster            The cluster number of the next cluster\r
\r
  @retval EFI_SUCCESS            The address is got\r
  @retval EFI_INVALID_PARAMETER  ClusterNo exceeds the MaxCluster of the volume.\r
  @retval EFI_DEVICE_ERROR       Read disk error\r
\r
**/\r
EFI_STATUS\r
FatGetNextCluster (\r
  IN  PEI_FAT_PRIVATE_DATA  *PrivateData,\r
  IN  PEI_FAT_VOLUME        *Volume,\r
  IN  UINT32                Cluster,\r
  OUT UINT32                *NextCluster\r
  );\r
\r
\r
/**\r
  Disk reading.\r
\r
  @param  PrivateData       the global memory map;\r
  @param  BlockDeviceNo     the block device to read;\r
  @param  StartingAddress   the starting address.\r
  @param  Size              the amount of data to read.\r
  @param  Buffer            the buffer holding the data\r
\r
  @retval EFI_SUCCESS       The function completed successfully.\r
  @retval EFI_DEVICE_ERROR  Something error.\r
\r
**/\r
EFI_STATUS\r
FatReadDisk (\r
  IN  PEI_FAT_PRIVATE_DATA  *PrivateData,\r
  IN  UINTN                 BlockDeviceNo,\r
  IN  UINT64                StartingAddress,\r
  IN  UINTN                 Size,\r
  OUT VOID                  *Buffer\r
  );\r
\r
\r
/**\r
  Set a file's CurrentPos and CurrentCluster, then compute StraightReadAmount.\r
\r
  @param  PrivateData            the global memory map\r
  @param  File                   the file\r
  @param  Pos                    the Position which is offset from the file's\r
                                 CurrentPos\r
\r
  @retval EFI_SUCCESS            Success.\r
  @retval EFI_INVALID_PARAMETER  Pos is beyond file's size.\r
  @retval EFI_DEVICE_ERROR       Something error while accessing media.\r
\r
**/\r
EFI_STATUS\r
FatSetFilePos (\r
  IN  PEI_FAT_PRIVATE_DATA  *PrivateData,\r
  IN  PEI_FAT_FILE          *File,\r
  IN  UINT32                Pos\r
  );\r
\r
\r
/**\r
  Reads file data. Updates the file's CurrentPos.\r
\r
  @param  PrivateData            Global memory map for accessing global variables\r
  @param  File                   The file.\r
  @param  Size                   The amount of data to read.\r
  @param  Buffer                 The buffer storing the data.\r
\r
  @retval EFI_SUCCESS            The data is read.\r
  @retval EFI_INVALID_PARAMETER  File is invalid.\r
  @retval EFI_DEVICE_ERROR       Something error while accessing media.\r
\r
**/\r
EFI_STATUS\r
FatReadFile (\r
  IN  PEI_FAT_PRIVATE_DATA  *PrivateData,\r
  IN  PEI_FAT_FILE          *File,\r
  IN  UINTN                 Size,\r
  OUT VOID                  *Buffer\r
  );\r
\r
\r
/**\r
  This function reads the next item in the parent directory and\r
  initializes the output parameter SubFile (CurrentPos is initialized to 0).\r
  The function updates the CurrentPos of the parent dir to after the item read.\r
  If no more items were found, the function returns EFI_NOT_FOUND.\r
\r
  @param  PrivateData            Global memory map for accessing global variables\r
  @param  ParentDir              The parent directory.\r
  @param  SubFile                The File structure containing the sub file that\r
                                 is caught.\r
\r
  @retval EFI_SUCCESS            The next sub file is obtained.\r
  @retval EFI_INVALID_PARAMETER  The ParentDir is not a directory.\r
  @retval EFI_NOT_FOUND          No more sub file exists.\r
  @retval EFI_DEVICE_ERROR       Something error while accessing media.\r
\r
**/\r
EFI_STATUS\r
FatReadNextDirectoryEntry (\r
  IN  PEI_FAT_PRIVATE_DATA  *PrivateData,\r
  IN  PEI_FAT_FILE          *ParentDir,\r
  OUT PEI_FAT_FILE          *SubFile\r
  );\r
\r
\r
/**\r
  This function finds partitions (logical devices) in physical block devices.\r
\r
  @param  PrivateData       Global memory map for accessing global variables.\r
\r
**/\r
VOID\r
FatFindPartitions (\r
  IN  PEI_FAT_PRIVATE_DATA  *PrivateData\r
  );\r
\r
#endif // _FAT_PEIM_H_\r
Commit	Line	Data
2f4dfa84 JJ	1	/** @file\r
	2	Data structures for FAT recovery PEIM\r
	3	\r
e38f26a2	4	Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
2f4dfa84 JJ	5	\r
	6	This program and the accompanying materials are licensed and made available\r
	7	under the terms and conditions of the BSD License which accompanies this\r
	8	distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef _FAT_PEIM_H_\r
	17	#define _FAT_PEIM_H_\r
	18	\r
	19	#include <PiPei.h>\r
	20	\r
	21	#include <Guid/RecoveryDevice.h>\r
	22	#include <Ppi/BlockIo.h>\r
8a467be1	23	#include <Ppi/BlockIo2.h>\r
2f4dfa84 JJ	24	#include <Ppi/DeviceRecoveryModule.h>\r
	25	\r
	26	#include <Library/DebugLib.h>\r
	27	#include <Library/BaseLib.h>\r
	28	#include <Library/PeimEntryPoint.h>\r
	29	#include <Library/BaseMemoryLib.h>\r
	30	#include <Library/PcdLib.h>\r
	31	#include <Library/PeiServicesTablePointerLib.h>\r
	32	#include <Library/PeiServicesLib.h>\r
	33	\r
	34	#include "FatLiteApi.h"\r
	35	#include "FatLiteFmt.h"\r
	36	\r
	37	//\r
	38	// Definitions\r
	39	//\r
2f4dfa84 JJ	40	\r
	41	#define PEI_FAT_CACHE_SIZE 4\r
	42	#define PEI_FAT_MAX_BLOCK_SIZE 8192\r
	43	#define FAT_MAX_FILE_NAME_LENGTH 128\r
	44	#define PEI_FAT_MAX_BLOCK_DEVICE 64\r
	45	#define PEI_FAT_MAX_BLOCK_IO_PPI 32\r
	46	#define PEI_FAT_MAX_VOLUME 64\r
	47	\r
	48	#define PEI_FAT_MEMMORY_PAGE_SIZE 0x1000\r
	49	\r
	50	//\r
	51	// Data Structures\r
	52	//\r
	53	//\r
	54	// The block device\r
	55	//\r
	56	typedef struct {\r
	57	\r
	58	UINT32 BlockSize;\r
	59	UINT64 LastBlock;\r
	60	UINT32 IoAlign;\r
	61	BOOLEAN Logical;\r
	62	BOOLEAN PartitionChecked;\r
	63	\r
	64	//\r
	65	// Following fields only valid for logical device\r
	66	//\r
	67	CHAR8 PartitionFlag[8];\r
	68	UINT64 StartingPos;\r
	69	UINTN ParentDevNo;\r
	70	\r
	71	//\r
	72	// Following fields only valid for physical device\r
	73	//\r
	74	EFI_PEI_BLOCK_DEVICE_TYPE DevType;\r
8a467be1	75	UINT8 InterfaceType;\r
2f4dfa84 JJ	76	//\r
	77	// EFI_PEI_READ_BLOCKS ReadFunc;\r
	78	//\r
8a467be1 FT	79	EFI_PEI_RECOVERY_BLOCK_IO_PPI *BlockIo;\r
	80	EFI_PEI_RECOVERY_BLOCK_IO2_PPI *BlockIo2;\r
	81	UINT8 PhysicalDevNo;\r
2f4dfa84 JJ	82	} PEI_FAT_BLOCK_DEVICE;\r
	83	\r
	84	//\r
	85	// the Volume structure\r
	86	//\r
	87	typedef struct {\r
	88	\r
	89	UINTN BlockDeviceNo;\r
	90	UINTN VolumeNo;\r
	91	UINT64 VolumeSize;\r
	92	UINTN MaxCluster;\r
	93	CHAR16 VolumeLabel[FAT_MAX_FILE_NAME_LENGTH];\r
	94	PEI_FAT_TYPE FatType;\r
	95	UINT64 FatPos;\r
	96	UINT32 SectorSize;\r
	97	UINT32 ClusterSize;\r
	98	UINT64 FirstClusterPos;\r
	99	UINT64 RootDirPos;\r
	100	UINT32 RootEntries;\r
	101	UINT32 RootDirCluster;\r
	102	\r
	103	} PEI_FAT_VOLUME;\r
	104	\r
	105	//\r
	106	// File instance\r
	107	//\r
	108	typedef struct {\r
	109	\r
	110	PEI_FAT_VOLUME *Volume;\r
	111	CHAR16 FileName[FAT_MAX_FILE_NAME_LENGTH];\r
	112	\r
	113	BOOLEAN IsFixedRootDir;\r
	114	\r
	115	UINT32 StartingCluster;\r
	116	UINT32 CurrentPos;\r
	117	UINT32 StraightReadAmount;\r
	118	UINT32 CurrentCluster;\r
	119	\r
	120	UINT8 Attributes;\r
	121	UINT32 FileSize;\r
	122	\r
	123	} PEI_FAT_FILE;\r
	124	\r
	125	//\r
	126	// Cache Buffer\r
	127	//\r
	128	typedef struct {\r
	129	\r
	130	BOOLEAN Valid;\r
	131	UINTN BlockDeviceNo;\r
	132	UINT64 Lba;\r
	133	UINT32 Lru;\r
	134	UINT64 Buffer[PEI_FAT_MAX_BLOCK_SIZE / 8];\r
	135	UINTN Size;\r
	136	\r
	137	} PEI_FAT_CACHE_BUFFER;\r
	138	\r
	139	//\r
	140	// Private Data.\r
	141	// This structure abstracts the whole memory usage in FAT PEIM.\r
	142	// The entry point routine will get a chunk of memory (by whatever\r
	143	// means) whose size is sizeof(PEI_FAT_PRIVATE_DATA), which is clean\r
	144	// in both 32 and 64 bit environment. The boundary of the memory chunk\r
	145	// should be 64bit aligned.\r
146	//\r
147	#define PEI_FAT_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('p', 'f', 'a', 't')\r
148	\r
149	typedef struct {\r
150	\r
151	UINTN Signature;\r
152	EFI_PEI_DEVICE_RECOVERY_MODULE_PPI DeviceRecoveryPpi;\r
153	EFI_PEI_PPI_DESCRIPTOR PpiDescriptor;\r
8a467be1	154	EFI_PEI_NOTIFY_DESCRIPTOR NotifyDescriptor[2];\r
2f4dfa84 JJ	155	\r
	156	UINT8 UnicodeCaseMap[0x300];\r
	157	CHAR8 *EngUpperMap;\r
	158	CHAR8 *EngLowerMap;\r
	159	CHAR8 *EngInfoMap;\r
	160	\r
	161	UINT64 BlockData[PEI_FAT_MAX_BLOCK_SIZE / 8];\r
	162	UINTN BlockDeviceCount;\r
	163	PEI_FAT_BLOCK_DEVICE BlockDevice[PEI_FAT_MAX_BLOCK_DEVICE];\r
	164	UINTN VolumeCount;\r
	165	PEI_FAT_VOLUME Volume[PEI_FAT_MAX_VOLUME];\r
	166	PEI_FAT_FILE File;\r
	167	PEI_FAT_CACHE_BUFFER CacheBuffer[PEI_FAT_CACHE_SIZE];\r
	168	\r
	169	} PEI_FAT_PRIVATE_DATA;\r
	170	\r
	171	#define PEI_FAT_PRIVATE_DATA_FROM_THIS(a) \\r
	172	CR (a, PEI_FAT_PRIVATE_DATA, DeviceRecoveryPpi, PEI_FAT_PRIVATE_DATA_SIGNATURE)\r
	173	\r
	174	//\r
	175	// Extract INT32 from char array\r
	176	//\r
	177	#define UNPACK_INT32(a) \\r
	178	(INT32) ((((UINT8 ) a)[0] << 0) \| (((UINT8 ) a)[1] << 8) \| (((UINT8 ) a)[2] << 16) \| (((UINT8 ) a)[3] << 24))\r
	179	\r
	180	//\r
	181	// Extract UINT32 from char array\r
	182	//\r
	183	#define UNPACK_UINT32(a) \\r
	184	(UINT32) ((((UINT8 ) a)[0] << 0) \| (((UINT8 ) a)[1] << 8) \| (((UINT8 ) a)[2] << 16) \| (((UINT8 ) a)[3] << 24))\r
	185	\r
	186	\r
	187	//\r
	188	// API functions\r
	189	//\r
	190	\r
	191	/**\r
	192	Finds the recovery file on a FAT volume.\r
	193	This function finds the the recovery file named FileName on a specified FAT volume and returns\r
	194	its FileHandle pointer.\r
	195	\r
e38f26a2 LG	196	@param PrivateData Global memory map for accessing global\r
	197	variables.\r
	198	@param VolumeIndex The index of the volume.\r
	199	@param FileName The recovery file name to find.\r
	200	@param Handle The output file handle.\r
2f4dfa84	201	\r
e38f26a2 LG	202	@retval EFI_DEVICE_ERROR Some error occured when operating the FAT\r
	203	volume.\r
	204	@retval EFI_NOT_FOUND The recovery file was not found.\r
	205	@retval EFI_SUCCESS The recovery file was successfully found on the\r
2f4dfa84 JJ	206	FAT volume.\r
	207	\r
	208	**/\r
	209	EFI_STATUS\r
	210	FindRecoveryFile (\r
	211	IN PEI_FAT_PRIVATE_DATA *PrivateData,\r
	212	IN UINTN VolumeIndex,\r
	213	IN CHAR16 *FileName,\r
	214	OUT PEI_FILE_HANDLE *Handle\r
	215	);\r
	216	\r
	217	\r
	218	/**\r
	219	Returns the number of DXE capsules residing on the device.\r
	220	This function, by whatever mechanism, searches for DXE capsules from the associated device and\r
	221	returns the number and maximum size in bytes of the capsules discovered.Entry 1 is assumed to be\r
	222	the highest load priority and entry N is assumed to be the lowest priority.\r
	223	\r
e38f26a2 LG	224	@param PeiServices General-purpose services that are available to\r
	225	every PEIM.\r
	226	@param This Indicates the\r
	227	EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
	228	@param NumberRecoveryCapsules Pointer to a caller-allocated UINTN.On output,\r
	229	*NumberRecoveryCapsules contains the number of\r
	230	recovery capsule images available for retrieval\r
	231	from this PEIM instance.\r
2f4dfa84 JJ	232	\r
	233	@retval EFI_SUCCESS The function completed successfully.\r
	234	\r
	235	**/\r
	236	EFI_STATUS\r
	237	EFIAPI\r
	238	GetNumberRecoveryCapsules (\r
	239	IN EFI_PEI_SERVICES **PeiServices,\r
	240	IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,\r
	241	OUT UINTN *NumberRecoveryCapsules\r
	242	);\r
	243	\r
	244	\r
	245	/**\r
	246	Returns the size and type of the requested recovery capsule.\r
	247	This function returns the size and type of the capsule specified by CapsuleInstance.\r
	248	\r
e38f26a2 LG	249	@param PeiServices General-purpose services that are available to\r
	250	every PEIM.\r
	251	@param This Indicates the\r
	252	EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
	253	@param CapsuleInstance Specifies for which capsule instance to\r
	254	retrieve the information.T his parameter must\r
	255	be between one and the value returned by\r
	256	GetNumberRecoveryCapsules() in\r
	257	NumberRecoveryCapsules.\r
	258	@param Size A pointer to a caller-allocated UINTN in which\r
	259	the size of the requested recovery module is\r
	260	returned.\r
	261	@param CapsuleType A pointer to a caller-allocated EFI_GUID in\r
	262	which the type of the requested recovery\r
	263	capsule is returned.T he semantic meaning of\r
	264	the value returned is defined by the\r
	265	implementation.\r
	266	\r
	267	@retval EFI_SUCCESS The capsule type and size were retrieved.\r
	268	@retval EFI_INVALID_PARAMETER The input CapsuleInstance does not match any\r
2f4dfa84 JJ	269	discovered recovery capsule.\r
	270	\r
	271	**/\r
	272	EFI_STATUS\r
	273	EFIAPI\r
	274	GetRecoveryCapsuleInfo (\r
	275	IN EFI_PEI_SERVICES **PeiServices,\r
	276	IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,\r
	277	IN UINTN CapsuleInstance,\r
	278	OUT UINTN *Size,\r
	279	OUT EFI_GUID *CapsuleType\r
	280	);\r
	281	\r
	282	\r
	283	/**\r
	284	Loads a DXE capsule from some media into memory.\r
	285	\r
	286	This function, by whatever mechanism, retrieves a DXE capsule from some device\r
	287	and loads it into memory. Note that the published interface is device neutral.\r
	288	\r
e38f26a2	289	@param[in] PeiServices General-purpose services that are available\r
2f4dfa84 JJ	290	to every PEIM\r
	291	@param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI\r
	292	instance.\r
	293	@param[in] CapsuleInstance Specifies which capsule instance to retrieve.\r
e38f26a2	294	@param[out] Buffer Specifies a caller-allocated buffer in which\r
2f4dfa84 JJ	295	the requested recovery capsule will be returned.\r
	296	\r
	297	@retval EFI_SUCCESS The capsule was loaded correctly.\r
	298	@retval EFI_DEVICE_ERROR A device error occurred.\r
	299	@retval EFI_NOT_FOUND A requested recovery DXE capsule cannot be found.\r
	300	\r
	301	**/\r
	302	EFI_STATUS\r
	303	EFIAPI\r
	304	LoadRecoveryCapsule (\r
	305	IN EFI_PEI_SERVICES **PeiServices,\r
	306	IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,\r
	307	IN UINTN CapsuleInstance,\r
	308	OUT VOID *Buffer\r
	309	);\r
	310	\r
	311	\r
	312	/**\r
	313	This version is different from the version in Unicode collation\r
	314	protocol in that this version strips off trailing blanks.\r
	315	Converts an 8.3 FAT file name using an OEM character set\r
	316	to a Null-terminated Unicode string.\r
	317	Here does not expand DBCS FAT chars.\r
	318	\r
e38f26a2 LG	319	@param FatSize The size of the string Fat in bytes.\r
	320	@param Fat A pointer to a Null-terminated string that contains\r
	321	an 8.3 file name using an OEM character set.\r
	322	@param Str A pointer to a Null-terminated Unicode string. The\r
	323	string must be allocated in advance to hold FatSize\r
2f4dfa84 JJ	324	Unicode characters\r
	325	\r
	326	**/\r
	327	VOID\r
	328	EngFatToStr (\r
	329	IN UINTN FatSize,\r
	330	IN CHAR8 *Fat,\r
	331	OUT CHAR16 *Str\r
	332	);\r
	333	\r
	334	\r
	335	/**\r
	336	Performs a case-insensitive comparison of two Null-terminated Unicode strings.\r
	337	\r
e38f26a2 LG	338	@param PrivateData Global memory map for accessing global variables\r
e38f26a2 LG	339	@param Str1 First string to perform case insensitive comparison.\r
2f4dfa84 JJ	340	@param Str2 Second string to perform case insensitive comparison.\r
	341	\r
	342	**/\r
	343	BOOLEAN\r
	344	EngStriColl (\r
	345	IN PEI_FAT_PRIVATE_DATA *PrivateData,\r
	346	IN CHAR16 *Str1,\r
	347	IN CHAR16 *Str2\r
	348	);\r
	349	\r
	350	\r
	351	/**\r
	352	Reads a block of data from the block device by calling\r
	353	underlying Block I/O service.\r
	354	\r
e38f26a2 LG	355	@param PrivateData Global memory map for accessing global variables\r
	356	@param BlockDeviceNo The index for the block device number.\r
	357	@param Lba The logic block address to read data from.\r
	358	@param BufferSize The size of data in byte to read.\r
	359	@param Buffer The buffer of the\r
2f4dfa84	360	\r
e38f26a2 LG	361	@retval EFI_DEVICE_ERROR The specified block device number exceeds the maximum\r
	362	device number.\r
	363	@retval EFI_DEVICE_ERROR The maximum address has exceeded the maximum address\r
2f4dfa84 JJ	364	of the block device.\r
	365	\r
	366	**/\r
	367	EFI_STATUS\r
	368	FatReadBlock (\r
	369	IN PEI_FAT_PRIVATE_DATA *PrivateData,\r
	370	IN UINTN BlockDeviceNo,\r
	371	IN EFI_PEI_LBA Lba,\r
	372	IN UINTN BufferSize,\r
	373	OUT VOID *Buffer\r
	374	);\r
	375	\r
	376	\r
	377	/**\r
	378	Check if there is a valid FAT in the corresponding Block device\r
	379	of the volume and if yes, fill in the relevant fields for the\r
	380	volume structure. Note there should be a valid Block device number\r
	381	already set.\r
	382	\r
e38f26a2 LG	383	@param PrivateData Global memory map for accessing global\r
	384	variables.\r
	385	@param Volume On input, the BlockDeviceNumber field of the\r
	386	Volume should be a valid value. On successful\r
	387	output, all fields except the VolumeNumber\r
	388	field is initialized.\r
2f4dfa84	389	\r
e38f26a2 LG	390	@retval EFI_SUCCESS A FAT is found and the volume structure is\r
	391	initialized.\r
	392	@retval EFI_NOT_FOUND There is no FAT on the corresponding device.\r
2f4dfa84 JJ	393	@retval EFI_DEVICE_ERROR There is something error while accessing device.\r
	394	\r
	395	**/\r
	396	EFI_STATUS\r
	397	FatGetBpbInfo (\r
	398	IN PEI_FAT_PRIVATE_DATA *PrivateData,\r
	399	IN OUT PEI_FAT_VOLUME *Volume\r
	400	);\r
	401	\r
	402	\r
	403	/**\r
	404	Gets the next cluster in the cluster chain.\r
	405	\r
e38f26a2 LG	406	@param PrivateData Global memory map for accessing global variables\r
	407	@param Volume The volume\r
	408	@param Cluster The cluster\r
	409	@param NextCluster The cluster number of the next cluster\r
2f4dfa84	410	\r
e38f26a2 LG	411	@retval EFI_SUCCESS The address is got\r
e38f26a2 LG	412	@retval EFI_INVALID_PARAMETER ClusterNo exceeds the MaxCluster of the volume.\r
2f4dfa84 JJ	413	@retval EFI_DEVICE_ERROR Read disk error\r
	414	\r
	415	**/\r
	416	EFI_STATUS\r
	417	FatGetNextCluster (\r
	418	IN PEI_FAT_PRIVATE_DATA *PrivateData,\r
	419	IN PEI_FAT_VOLUME *Volume,\r
	420	IN UINT32 Cluster,\r
	421	OUT UINT32 *NextCluster\r
	422	);\r
	423	\r
	424	\r
	425	/**\r
	426	Disk reading.\r
	427	\r
e38f26a2 LG	428	@param PrivateData the global memory map;\r
	429	@param BlockDeviceNo the block device to read;\r
	430	@param StartingAddress the starting address.\r
	431	@param Size the amount of data to read.\r
	432	@param Buffer the buffer holding the data\r
2f4dfa84 JJ	433	\r
	434	@retval EFI_SUCCESS The function completed successfully.\r
	435	@retval EFI_DEVICE_ERROR Something error.\r
	436	\r
	437	**/\r
	438	EFI_STATUS\r
	439	FatReadDisk (\r
	440	IN PEI_FAT_PRIVATE_DATA *PrivateData,\r
	441	IN UINTN BlockDeviceNo,\r
	442	IN UINT64 StartingAddress,\r
	443	IN UINTN Size,\r
	444	OUT VOID *Buffer\r
	445	);\r
	446	\r
	447	\r
	448	/**\r
	449	Set a file's CurrentPos and CurrentCluster, then compute StraightReadAmount.\r
	450	\r
e38f26a2 LG	451	@param PrivateData the global memory map\r
	452	@param File the file\r
	453	@param Pos the Position which is offset from the file's\r
	454	CurrentPos\r
2f4dfa84	455	\r
e38f26a2 LG	456	@retval EFI_SUCCESS Success.\r
e38f26a2 LG	457	@retval EFI_INVALID_PARAMETER Pos is beyond file's size.\r
2f4dfa84 JJ	458	@retval EFI_DEVICE_ERROR Something error while accessing media.\r
	459	\r
	460	**/\r
	461	EFI_STATUS\r
	462	FatSetFilePos (\r
	463	IN PEI_FAT_PRIVATE_DATA *PrivateData,\r
	464	IN PEI_FAT_FILE *File,\r
	465	IN UINT32 Pos\r
	466	);\r
	467	\r
	468	\r
	469	/**\r
	470	Reads file data. Updates the file's CurrentPos.\r
	471	\r
e38f26a2 LG	472	@param PrivateData Global memory map for accessing global variables\r
	473	@param File The file.\r
	474	@param Size The amount of data to read.\r
	475	@param Buffer The buffer storing the data.\r
2f4dfa84	476	\r
e38f26a2 LG	477	@retval EFI_SUCCESS The data is read.\r
e38f26a2 LG	478	@retval EFI_INVALID_PARAMETER File is invalid.\r
2f4dfa84 JJ	479	@retval EFI_DEVICE_ERROR Something error while accessing media.\r
	480	\r
	481	**/\r
	482	EFI_STATUS\r
	483	FatReadFile (\r
	484	IN PEI_FAT_PRIVATE_DATA *PrivateData,\r
	485	IN PEI_FAT_FILE *File,\r
	486	IN UINTN Size,\r
	487	OUT VOID *Buffer\r
	488	);\r
	489	\r
	490	\r
	491	/**\r
	492	This function reads the next item in the parent directory and\r
	493	initializes the output parameter SubFile (CurrentPos is initialized to 0).\r
	494	The function updates the CurrentPos of the parent dir to after the item read.\r
	495	If no more items were found, the function returns EFI_NOT_FOUND.\r
	496	\r
e38f26a2 LG	497	@param PrivateData Global memory map for accessing global variables\r
	498	@param ParentDir The parent directory.\r
	499	@param SubFile The File structure containing the sub file that\r
	500	is caught.\r
2f4dfa84	501	\r
e38f26a2 LG	502	@retval EFI_SUCCESS The next sub file is obtained.\r
	503	@retval EFI_INVALID_PARAMETER The ParentDir is not a directory.\r
	504	@retval EFI_NOT_FOUND No more sub file exists.\r
2f4dfa84 JJ	505	@retval EFI_DEVICE_ERROR Something error while accessing media.\r
	506	\r
	507	**/\r
	508	EFI_STATUS\r
	509	FatReadNextDirectoryEntry (\r
	510	IN PEI_FAT_PRIVATE_DATA *PrivateData,\r
	511	IN PEI_FAT_FILE *ParentDir,\r
	512	OUT PEI_FAT_FILE *SubFile\r
	513	);\r
	514	\r
	515	\r
	516	/**\r
	517	This function finds partitions (logical devices) in physical block devices.\r
	518	\r
	519	@param PrivateData Global memory map for accessing global variables.\r
	520	\r
	521	**/\r
	522	VOID\r
	523	FatFindPartitions (\r
	524	IN PEI_FAT_PRIVATE_DATA *PrivateData\r
	525	);\r
	526	\r
	527	#endif // _FAT_PEIM_H_\r