From: Liming Gao Date: Wed, 27 Jun 2018 13:06:14 +0000 (+0800) Subject: FatPkg: Clean up source files X-Git-Tag: edk2-stable201903~1508 X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=e38f26a2f7f62b69fec2d84e83bcc4b45ddefdc1 FatPkg: Clean up source files 1. Do not use tab characters 2. No trailing white space in one line 3. All files must end with CRLF Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Liming Gao Reviewed-by: Ruiyu Ni --- diff --git a/FatPkg/EnhancedFatDxe/FatExtra.uni b/FatPkg/EnhancedFatDxe/FatExtra.uni index 1c66929861..37e68b1cb3 100644 --- a/FatPkg/EnhancedFatDxe/FatExtra.uni +++ b/FatPkg/EnhancedFatDxe/FatExtra.uni @@ -1,7 +1,7 @@ // /** @file // Fat Localized Strings and Content // -// Copyright (c) 2013, Intel Corporation. All rights reserved.
+// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
// // This program and the accompanying materials are licensed and made available // under the terms and conditions of the BSD License which accompanies this @@ -13,8 +13,8 @@ // // **/ -#string STR_PROPERTIES_MODULE_NAME -#language en-US +#string STR_PROPERTIES_MODULE_NAME +#language en-US "FAT File System DXE Driver" diff --git a/FatPkg/EnhancedFatDxe/Misc.c b/FatPkg/EnhancedFatDxe/Misc.c index af66b1d0e3..244b9dd921 100644 --- a/FatPkg/EnhancedFatDxe/Misc.c +++ b/FatPkg/EnhancedFatDxe/Misc.c @@ -1,7 +1,7 @@ /** @file Miscellaneous functions. -Copyright (c) 2005 - 2013, Intel Corporation. All rights reserved.
+Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
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 @@ -164,7 +164,7 @@ FatQueueTask ( ) { Subtask = CR (Link, FAT_SUBTASK, Link, FAT_SUBTASK_SIGNATURE); if (Subtask->Write) { - + Status = IFile->OFile->Volume->DiskIo2->WriteDiskEx ( IFile->OFile->Volume->DiskIo2, IFile->OFile->Volume->MediaId, diff --git a/FatPkg/EnhancedFatDxe/Open.c b/FatPkg/EnhancedFatDxe/Open.c index 7b273fe1b1..a64f8ff1f3 100644 --- a/FatPkg/EnhancedFatDxe/Open.c +++ b/FatPkg/EnhancedFatDxe/Open.c @@ -1,7 +1,7 @@ /** @file Routines dealing with file open. -Copyright (c) 2005 - 2014, Intel Corporation. All rights reserved.
+Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
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 @@ -234,7 +234,7 @@ FatOpenEx ( } // - // Check for valid Attributes for file creation case. + // Check for valid Attributes for file creation case. // if (((OpenMode & EFI_FILE_MODE_CREATE) != 0) && (Attributes & (EFI_FILE_READ_ONLY | (~EFI_FILE_VALID_ATTR))) != 0) { return EFI_INVALID_PARAMETER; diff --git a/FatPkg/EnhancedFatDxe/UnicodeCollation.c b/FatPkg/EnhancedFatDxe/UnicodeCollation.c index b240a931ff..0c178fad43 100644 --- a/FatPkg/EnhancedFatDxe/UnicodeCollation.c +++ b/FatPkg/EnhancedFatDxe/UnicodeCollation.c @@ -2,7 +2,7 @@ Unicode Collation Support component that hides the trivial difference of Unicode Collation and Unicode collation 2 Protocol. - Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.
+ Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
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 @@ -83,7 +83,7 @@ InitializeUnicodeCollationSupportWorker ( // // Find the best matching matching language from the supported languages - // of Unicode Collation (2) protocol. + // of Unicode Collation (2) protocol. // BestLanguage = GetBestLanguage ( Uci->SupportedLanguages, diff --git a/FatPkg/FatPei/FatLiteAccess.c b/FatPkg/FatPei/FatLiteAccess.c index a92c5bff99..12a3be33c5 100644 --- a/FatPkg/FatPei/FatLiteAccess.c +++ b/FatPkg/FatPei/FatLiteAccess.c @@ -1,7 +1,7 @@ /** @file FAT file system access routines for FAT recovery PEIM -Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this @@ -22,16 +22,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. volume structure. Note there should be a valid Block device number already set. - @param PrivateData Global memory map for accessing global - variables. - @param Volume On input, the BlockDeviceNumber field of the - Volume should be a valid value. On successful - output, all fields except the VolumeNumber - field is initialized. + @param PrivateData Global memory map for accessing global + variables. + @param Volume On input, the BlockDeviceNumber field of the + Volume should be a valid value. On successful + output, all fields except the VolumeNumber + field is initialized. - @retval EFI_SUCCESS A FAT is found and the volume structure is - initialized. - @retval EFI_NOT_FOUND There is no FAT on the corresponding device. + @retval EFI_SUCCESS A FAT is found and the volume structure is + initialized. + @retval EFI_NOT_FOUND There is no FAT on the corresponding device. @retval EFI_DEVICE_ERROR There is something error while accessing device. **/ @@ -177,13 +177,13 @@ FatGetBpbInfo ( /** Gets the next cluster in the cluster chain - @param PrivateData Global memory map for accessing global variables - @param Volume The volume - @param Cluster The cluster - @param NextCluster The cluster number of the next cluster + @param PrivateData Global memory map for accessing global variables + @param Volume The volume + @param Cluster The cluster + @param NextCluster The cluster number of the next cluster - @retval EFI_SUCCESS The address is got - @retval EFI_INVALID_PARAMETER ClusterNo exceeds the MaxCluster of the volume. + @retval EFI_SUCCESS The address is got + @retval EFI_INVALID_PARAMETER ClusterNo exceeds the MaxCluster of the volume. @retval EFI_DEVICE_ERROR Read disk error **/ @@ -256,13 +256,13 @@ FatGetNextCluster ( /** Set a file's CurrentPos and CurrentCluster, then compute StraightReadAmount. - @param PrivateData the global memory map - @param File the file - @param Pos the Position which is offset from the file's - CurrentPos + @param PrivateData the global memory map + @param File the file + @param Pos the Position which is offset from the file's + CurrentPos - @retval EFI_SUCCESS Success. - @retval EFI_INVALID_PARAMETER Pos is beyond file's size. + @retval EFI_SUCCESS Success. + @retval EFI_INVALID_PARAMETER Pos is beyond file's size. @retval EFI_DEVICE_ERROR Something error while accessing media. **/ @@ -346,13 +346,13 @@ FatSetFilePos ( /** Reads file data. Updates the file's CurrentPos. - @param PrivateData Global memory map for accessing global variables - @param File The file. - @param Size The amount of data to read. - @param Buffer The buffer storing the data. + @param PrivateData Global memory map for accessing global variables + @param File The file. + @param Size The amount of data to read. + @param Buffer The buffer storing the data. - @retval EFI_SUCCESS The data is read. - @retval EFI_INVALID_PARAMETER File is invalid. + @retval EFI_SUCCESS The data is read. + @retval EFI_INVALID_PARAMETER File is invalid. @retval EFI_DEVICE_ERROR Something error while accessing media. **/ @@ -434,14 +434,14 @@ FatReadFile ( The function updates the CurrentPos of the parent dir to after the item read. If no more items were found, the function returns EFI_NOT_FOUND. - @param PrivateData Global memory map for accessing global variables - @param ParentDir The parent directory. - @param SubFile The File structure containing the sub file that - is caught. + @param PrivateData Global memory map for accessing global variables + @param ParentDir The parent directory. + @param SubFile The File structure containing the sub file that + is caught. - @retval EFI_SUCCESS The next sub file is obtained. - @retval EFI_INVALID_PARAMETER The ParentDir is not a directory. - @retval EFI_NOT_FOUND No more sub file exists. + @retval EFI_SUCCESS The next sub file is obtained. + @retval EFI_INVALID_PARAMETER The ParentDir is not a directory. + @retval EFI_NOT_FOUND No more sub file exists. @retval EFI_DEVICE_ERROR Something error while accessing media. **/ diff --git a/FatPkg/FatPei/FatLiteApi.c b/FatPkg/FatPei/FatLiteApi.c index b455390610..b71eaaab2a 100644 --- a/FatPkg/FatPei/FatLiteApi.c +++ b/FatPkg/FatPei/FatLiteApi.c @@ -21,12 +21,12 @@ PEI_FAT_PRIVATE_DATA *mPrivateData = NULL; BlockIo installation nofication function. Find out all the current BlockIO PPIs in the system and add them into private data. Assume there is - @param PeiServices General purpose services available to every - PEIM. - @param NotifyDescriptor The typedef structure of the notification - descriptor. Not used in this function. - @param Ppi The typedef structure of the PPI descriptor. - Not used in this function. + @param PeiServices General purpose services available to every + PEIM. + @param NotifyDescriptor The typedef structure of the notification + descriptor. Not used in this function. + @param Ppi The typedef structure of the PPI descriptor. + Not used in this function. @retval EFI_SUCCESS The function completed successfully. @@ -43,8 +43,8 @@ BlockIoNotifyEntry ( /** Discover all the block I/O devices to find the FAT volume. - @param PrivateData Global memory map for accessing global - variables. + @param PrivateData Global memory map for accessing global + variables. @param BlockIo2 Boolean to show whether using BlockIo2 or BlockIo @retval EFI_SUCCESS The function completed successfully. @@ -203,12 +203,12 @@ UpdateBlocksAndVolumes ( BlockIo installation notification function. Find out all the current BlockIO PPIs in the system and add them into private data. Assume there is - @param PeiServices General purpose services available to every - PEIM. - @param NotifyDescriptor The typedef structure of the notification - descriptor. Not used in this function. - @param Ppi The typedef structure of the PPI descriptor. - Not used in this function. + @param PeiServices General purpose services available to every + PEIM. + @param NotifyDescriptor The typedef structure of the notification + descriptor. Not used in this function. + @param Ppi The typedef structure of the PPI descriptor. + Not used in this function. @retval EFI_SUCCESS The function completed successfully. @@ -234,13 +234,13 @@ BlockIoNotifyEntry ( Installs the Device Recovery Module PPI, Initialize BlockIo Ppi installation notification - @param FileHandle Handle of the file being invoked. Type - EFI_PEI_FILE_HANDLE is defined in - FfsFindNextFile(). - @param PeiServices Describes the list of possible PEI Services. + @param FileHandle Handle of the file being invoked. Type + EFI_PEI_FILE_HANDLE is defined in + FfsFindNextFile(). + @param PeiServices Describes the list of possible PEI Services. - @retval EFI_SUCCESS The entry point was executed successfully. - @retval EFI_OUT_OF_RESOURCES There is no enough memory to complete the + @retval EFI_SUCCESS The entry point was executed successfully. + @retval EFI_OUT_OF_RESOURCES There is no enough memory to complete the operations. **/ @@ -330,18 +330,18 @@ FatPeimEntry ( Returns the number of DXE capsules residing on the device. This function searches for DXE capsules from the associated device and returns - the number and maximum size in bytes of the capsules discovered. Entry 1 is - assumed to be the highest load priority and entry N is assumed to be the lowest + the number and maximum size in bytes of the capsules discovered. Entry 1 is + assumed to be the highest load priority and entry N is assumed to be the lowest priority. - @param[in] PeiServices General-purpose services that are available + @param[in] PeiServices General-purpose services that are available to every PEIM @param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. - @param[out] NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On - output, *NumberRecoveryCapsules contains - the number of recovery capsule images - available for retrieval from this PEIM + @param[out] NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On + output, *NumberRecoveryCapsules contains + the number of recovery capsule images + available for retrieval from this PEIM instance. @retval EFI_SUCCESS One or more capsules were discovered. @@ -394,18 +394,18 @@ GetNumberRecoveryCapsules ( This function gets the size and type of the capsule specified by CapsuleInstance. @param[in] PeiServices General-purpose services that are available to every PEIM - @param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI + @param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. - @param[in] CapsuleInstance Specifies for which capsule instance to retrieve - the information. This parameter must be between - one and the value returned by GetNumberRecoveryCapsules() + @param[in] CapsuleInstance Specifies for which capsule instance to retrieve + the information. This parameter must be between + one and the value returned by GetNumberRecoveryCapsules() in NumberRecoveryCapsules. - @param[out] Size A pointer to a caller-allocated UINTN in which - the size of the requested recovery module is + @param[out] Size A pointer to a caller-allocated UINTN in which + the size of the requested recovery module is returned. - @param[out] CapsuleType A pointer to a caller-allocated EFI_GUID in which - the type of the requested recovery capsule is - returned. The semantic meaning of the value + @param[out] CapsuleType A pointer to a caller-allocated EFI_GUID in which + the type of the requested recovery capsule is + returned. The semantic meaning of the value returned is defined by the implementation. @retval EFI_SUCCESS One or more capsules were discovered. @@ -530,12 +530,12 @@ GetRecoveryCapsuleInfo ( This function, by whatever mechanism, retrieves a DXE capsule from some device and loads it into memory. Note that the published interface is device neutral. - @param[in] PeiServices General-purpose services that are available + @param[in] PeiServices General-purpose services that are available to every PEIM @param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. @param[in] CapsuleInstance Specifies which capsule instance to retrieve. - @param[out] Buffer Specifies a caller-allocated buffer in which + @param[out] Buffer Specifies a caller-allocated buffer in which the requested recovery capsule will be returned. @retval EFI_SUCCESS The capsule was loaded correctly. @@ -608,16 +608,16 @@ LoadRecoveryCapsule ( This function finds the the recovery file named FileName on a specified FAT volume and returns its FileHandle pointer. - @param PrivateData Global memory map for accessing global - variables. - @param VolumeIndex The index of the volume. - @param FileName The recovery file name to find. - @param Handle The output file handle. + @param PrivateData Global memory map for accessing global + variables. + @param VolumeIndex The index of the volume. + @param FileName The recovery file name to find. + @param Handle The output file handle. - @retval EFI_DEVICE_ERROR Some error occured when operating the FAT - volume. - @retval EFI_NOT_FOUND The recovery file was not found. - @retval EFI_SUCCESS The recovery file was successfully found on the + @retval EFI_DEVICE_ERROR Some error occured when operating the FAT + volume. + @retval EFI_NOT_FOUND The recovery file was not found. + @retval EFI_SUCCESS The recovery file was successfully found on the FAT volume. **/ diff --git a/FatPkg/FatPei/FatLiteLib.c b/FatPkg/FatPei/FatLiteLib.c index 109789a54b..947fee42f1 100644 --- a/FatPkg/FatPei/FatLiteLib.c +++ b/FatPkg/FatPei/FatLiteLib.c @@ -1,7 +1,7 @@ /** @file General purpose supporting routines for FAT recovery PEIM -Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this @@ -25,7 +25,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. If the input Letter is not a lower-cased letter, the original value is returned. - @param Letter The input unicode character. + @param Letter The input unicode character. @return The upper cased letter. @@ -47,15 +47,15 @@ ToUpper ( Reads a block of data from the block device by calling underlying Block I/O service. - @param PrivateData Global memory map for accessing global variables - @param BlockDeviceNo The index for the block device number. - @param Lba The logic block address to read data from. - @param BufferSize The size of data in byte to read. - @param Buffer The buffer of the + @param PrivateData Global memory map for accessing global variables + @param BlockDeviceNo The index for the block device number. + @param Lba The logic block address to read data from. + @param BufferSize The size of data in byte to read. + @param Buffer The buffer of the - @retval EFI_DEVICE_ERROR The specified block device number exceeds the maximum - device number. - @retval EFI_DEVICE_ERROR The maximum address has exceeded the maximum address + @retval EFI_DEVICE_ERROR The specified block device number exceeds the maximum + device number. + @retval EFI_DEVICE_ERROR The maximum address has exceeded the maximum address of the block device. **/ @@ -125,11 +125,11 @@ FatReadBlock ( Find a cache block designated to specific Block device and Lba. If not found, invalidate an oldest one and use it. (LRU cache) - @param PrivateData the global memory map. - @param BlockDeviceNo the Block device. - @param Lba the Logical Block Address - @param CachePtr Ptr to the starting address of the memory holding the - data; + @param PrivateData the global memory map. + @param BlockDeviceNo the Block device. + @param Lba the Logical Block Address + @param CachePtr Ptr to the starting address of the memory holding the + data; @retval EFI_SUCCESS The function completed successfully. @retval EFI_DEVICE_ERROR Something error while accessing media. @@ -179,9 +179,9 @@ FatGetCacheBlock ( if (Index == PEI_FAT_CACHE_SIZE) { Index = (Seed++) % PEI_FAT_CACHE_SIZE; } - + // - // Current device ID should be less than maximum device ID. + // Current device ID should be less than maximum device ID. // if (BlockDeviceNo >= PEI_FAT_MAX_BLOCK_DEVICE) { return EFI_DEVICE_ERROR; @@ -217,11 +217,11 @@ FatGetCacheBlock ( /** Disk reading. - @param PrivateData the global memory map; - @param BlockDeviceNo the block device to read; - @param StartingAddress the starting address. - @param Size the amount of data to read. - @param Buffer the buffer holding the data + @param PrivateData the global memory map; + @param BlockDeviceNo the block device to read; + @param StartingAddress the starting address. + @param Size the amount of data to read. + @param Buffer the buffer holding the data @retval EFI_SUCCESS The function completed successfully. @retval EFI_DEVICE_ERROR Something error. @@ -306,11 +306,11 @@ FatReadDisk ( to a Null-terminated Unicode string. Here does not expand DBCS FAT chars. - @param FatSize The size of the string Fat in bytes. - @param Fat A pointer to a Null-terminated string that contains - an 8.3 file name using an OEM character set. - @param Str A pointer to a Null-terminated Unicode string. The - string must be allocated in advance to hold FatSize + @param FatSize The size of the string Fat in bytes. + @param Fat A pointer to a Null-terminated string that contains + an 8.3 file name using an OEM character set. + @param Str A pointer to a Null-terminated Unicode string. The + string must be allocated in advance to hold FatSize Unicode characters **/ @@ -344,8 +344,8 @@ EngFatToStr ( /** Performs a case-insensitive comparison of two Null-terminated Unicode strings. - @param PrivateData Global memory map for accessing global variables - @param Str1 First string to perform case insensitive comparison. + @param PrivateData Global memory map for accessing global variables + @param Str1 First string to perform case insensitive comparison. @param Str2 Second string to perform case insensitive comparison. **/ diff --git a/FatPkg/FatPei/FatLitePeim.h b/FatPkg/FatPei/FatLitePeim.h index d343d88f7e..fbf887da5f 100644 --- a/FatPkg/FatPei/FatLitePeim.h +++ b/FatPkg/FatPei/FatLitePeim.h @@ -1,7 +1,7 @@ /** @file Data structures for FAT recovery PEIM -Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this @@ -193,16 +193,16 @@ typedef struct { This function finds the the recovery file named FileName on a specified FAT volume and returns its FileHandle pointer. - @param PrivateData Global memory map for accessing global - variables. - @param VolumeIndex The index of the volume. - @param FileName The recovery file name to find. - @param Handle The output file handle. + @param PrivateData Global memory map for accessing global + variables. + @param VolumeIndex The index of the volume. + @param FileName The recovery file name to find. + @param Handle The output file handle. - @retval EFI_DEVICE_ERROR Some error occured when operating the FAT - volume. - @retval EFI_NOT_FOUND The recovery file was not found. - @retval EFI_SUCCESS The recovery file was successfully found on the + @retval EFI_DEVICE_ERROR Some error occured when operating the FAT + volume. + @retval EFI_NOT_FOUND The recovery file was not found. + @retval EFI_SUCCESS The recovery file was successfully found on the FAT volume. **/ @@ -221,14 +221,14 @@ FindRecoveryFile ( returns the number and maximum size in bytes of the capsules discovered.Entry 1 is assumed to be the highest load priority and entry N is assumed to be the lowest priority. - @param PeiServices General-purpose services that are available to - every PEIM. - @param This Indicates the - EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. - @param NumberRecoveryCapsules Pointer to a caller-allocated UINTN.On output, - *NumberRecoveryCapsules contains the number of - recovery capsule images available for retrieval - from this PEIM instance. + @param PeiServices General-purpose services that are available to + every PEIM. + @param This Indicates the + EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. + @param NumberRecoveryCapsules Pointer to a caller-allocated UINTN.On output, + *NumberRecoveryCapsules contains the number of + recovery capsule images available for retrieval + from this PEIM instance. @retval EFI_SUCCESS The function completed successfully. @@ -246,26 +246,26 @@ GetNumberRecoveryCapsules ( Returns the size and type of the requested recovery capsule. This function returns the size and type of the capsule specified by CapsuleInstance. - @param PeiServices General-purpose services that are available to - every PEIM. - @param This Indicates the - EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. - @param CapsuleInstance Specifies for which capsule instance to - retrieve the information.T his parameter must - be between one and the value returned by - GetNumberRecoveryCapsules() in - NumberRecoveryCapsules. - @param Size A pointer to a caller-allocated UINTN in which - the size of the requested recovery module is - returned. - @param CapsuleType A pointer to a caller-allocated EFI_GUID in - which the type of the requested recovery - capsule is returned.T he semantic meaning of - the value returned is defined by the - implementation. - - @retval EFI_SUCCESS The capsule type and size were retrieved. - @retval EFI_INVALID_PARAMETER The input CapsuleInstance does not match any + @param PeiServices General-purpose services that are available to + every PEIM. + @param This Indicates the + EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. + @param CapsuleInstance Specifies for which capsule instance to + retrieve the information.T his parameter must + be between one and the value returned by + GetNumberRecoveryCapsules() in + NumberRecoveryCapsules. + @param Size A pointer to a caller-allocated UINTN in which + the size of the requested recovery module is + returned. + @param CapsuleType A pointer to a caller-allocated EFI_GUID in + which the type of the requested recovery + capsule is returned.T he semantic meaning of + the value returned is defined by the + implementation. + + @retval EFI_SUCCESS The capsule type and size were retrieved. + @retval EFI_INVALID_PARAMETER The input CapsuleInstance does not match any discovered recovery capsule. **/ @@ -286,12 +286,12 @@ GetRecoveryCapsuleInfo ( This function, by whatever mechanism, retrieves a DXE capsule from some device and loads it into memory. Note that the published interface is device neutral. - @param[in] PeiServices General-purpose services that are available + @param[in] PeiServices General-purpose services that are available to every PEIM @param[in] This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. @param[in] CapsuleInstance Specifies which capsule instance to retrieve. - @param[out] Buffer Specifies a caller-allocated buffer in which + @param[out] Buffer Specifies a caller-allocated buffer in which the requested recovery capsule will be returned. @retval EFI_SUCCESS The capsule was loaded correctly. @@ -316,11 +316,11 @@ LoadRecoveryCapsule ( to a Null-terminated Unicode string. Here does not expand DBCS FAT chars. - @param FatSize The size of the string Fat in bytes. - @param Fat A pointer to a Null-terminated string that contains - an 8.3 file name using an OEM character set. - @param Str A pointer to a Null-terminated Unicode string. The - string must be allocated in advance to hold FatSize + @param FatSize The size of the string Fat in bytes. + @param Fat A pointer to a Null-terminated string that contains + an 8.3 file name using an OEM character set. + @param Str A pointer to a Null-terminated Unicode string. The + string must be allocated in advance to hold FatSize Unicode characters **/ @@ -335,8 +335,8 @@ EngFatToStr ( /** Performs a case-insensitive comparison of two Null-terminated Unicode strings. - @param PrivateData Global memory map for accessing global variables - @param Str1 First string to perform case insensitive comparison. + @param PrivateData Global memory map for accessing global variables + @param Str1 First string to perform case insensitive comparison. @param Str2 Second string to perform case insensitive comparison. **/ @@ -352,15 +352,15 @@ EngStriColl ( Reads a block of data from the block device by calling underlying Block I/O service. - @param PrivateData Global memory map for accessing global variables - @param BlockDeviceNo The index for the block device number. - @param Lba The logic block address to read data from. - @param BufferSize The size of data in byte to read. - @param Buffer The buffer of the + @param PrivateData Global memory map for accessing global variables + @param BlockDeviceNo The index for the block device number. + @param Lba The logic block address to read data from. + @param BufferSize The size of data in byte to read. + @param Buffer The buffer of the - @retval EFI_DEVICE_ERROR The specified block device number exceeds the maximum - device number. - @retval EFI_DEVICE_ERROR The maximum address has exceeded the maximum address + @retval EFI_DEVICE_ERROR The specified block device number exceeds the maximum + device number. + @retval EFI_DEVICE_ERROR The maximum address has exceeded the maximum address of the block device. **/ @@ -380,16 +380,16 @@ FatReadBlock ( volume structure. Note there should be a valid Block device number already set. - @param PrivateData Global memory map for accessing global - variables. - @param Volume On input, the BlockDeviceNumber field of the - Volume should be a valid value. On successful - output, all fields except the VolumeNumber - field is initialized. + @param PrivateData Global memory map for accessing global + variables. + @param Volume On input, the BlockDeviceNumber field of the + Volume should be a valid value. On successful + output, all fields except the VolumeNumber + field is initialized. - @retval EFI_SUCCESS A FAT is found and the volume structure is - initialized. - @retval EFI_NOT_FOUND There is no FAT on the corresponding device. + @retval EFI_SUCCESS A FAT is found and the volume structure is + initialized. + @retval EFI_NOT_FOUND There is no FAT on the corresponding device. @retval EFI_DEVICE_ERROR There is something error while accessing device. **/ @@ -403,13 +403,13 @@ FatGetBpbInfo ( /** Gets the next cluster in the cluster chain. - @param PrivateData Global memory map for accessing global variables - @param Volume The volume - @param Cluster The cluster - @param NextCluster The cluster number of the next cluster + @param PrivateData Global memory map for accessing global variables + @param Volume The volume + @param Cluster The cluster + @param NextCluster The cluster number of the next cluster - @retval EFI_SUCCESS The address is got - @retval EFI_INVALID_PARAMETER ClusterNo exceeds the MaxCluster of the volume. + @retval EFI_SUCCESS The address is got + @retval EFI_INVALID_PARAMETER ClusterNo exceeds the MaxCluster of the volume. @retval EFI_DEVICE_ERROR Read disk error **/ @@ -425,11 +425,11 @@ FatGetNextCluster ( /** Disk reading. - @param PrivateData the global memory map; - @param BlockDeviceNo the block device to read; - @param StartingAddress the starting address. - @param Size the amount of data to read. - @param Buffer the buffer holding the data + @param PrivateData the global memory map; + @param BlockDeviceNo the block device to read; + @param StartingAddress the starting address. + @param Size the amount of data to read. + @param Buffer the buffer holding the data @retval EFI_SUCCESS The function completed successfully. @retval EFI_DEVICE_ERROR Something error. @@ -448,13 +448,13 @@ FatReadDisk ( /** Set a file's CurrentPos and CurrentCluster, then compute StraightReadAmount. - @param PrivateData the global memory map - @param File the file - @param Pos the Position which is offset from the file's - CurrentPos + @param PrivateData the global memory map + @param File the file + @param Pos the Position which is offset from the file's + CurrentPos - @retval EFI_SUCCESS Success. - @retval EFI_INVALID_PARAMETER Pos is beyond file's size. + @retval EFI_SUCCESS Success. + @retval EFI_INVALID_PARAMETER Pos is beyond file's size. @retval EFI_DEVICE_ERROR Something error while accessing media. **/ @@ -469,13 +469,13 @@ FatSetFilePos ( /** Reads file data. Updates the file's CurrentPos. - @param PrivateData Global memory map for accessing global variables - @param File The file. - @param Size The amount of data to read. - @param Buffer The buffer storing the data. + @param PrivateData Global memory map for accessing global variables + @param File The file. + @param Size The amount of data to read. + @param Buffer The buffer storing the data. - @retval EFI_SUCCESS The data is read. - @retval EFI_INVALID_PARAMETER File is invalid. + @retval EFI_SUCCESS The data is read. + @retval EFI_INVALID_PARAMETER File is invalid. @retval EFI_DEVICE_ERROR Something error while accessing media. **/ @@ -494,14 +494,14 @@ FatReadFile ( The function updates the CurrentPos of the parent dir to after the item read. If no more items were found, the function returns EFI_NOT_FOUND. - @param PrivateData Global memory map for accessing global variables - @param ParentDir The parent directory. - @param SubFile The File structure containing the sub file that - is caught. + @param PrivateData Global memory map for accessing global variables + @param ParentDir The parent directory. + @param SubFile The File structure containing the sub file that + is caught. - @retval EFI_SUCCESS The next sub file is obtained. - @retval EFI_INVALID_PARAMETER The ParentDir is not a directory. - @retval EFI_NOT_FOUND No more sub file exists. + @retval EFI_SUCCESS The next sub file is obtained. + @retval EFI_INVALID_PARAMETER The ParentDir is not a directory. + @retval EFI_NOT_FOUND No more sub file exists. @retval EFI_DEVICE_ERROR Something error while accessing media. **/ diff --git a/FatPkg/FatPei/FatPeiExtra.uni b/FatPkg/FatPei/FatPeiExtra.uni index 83a02f6ed3..24562b4c7c 100644 --- a/FatPkg/FatPei/FatPeiExtra.uni +++ b/FatPkg/FatPei/FatPeiExtra.uni @@ -1,7 +1,7 @@ // /** @file // FatPei Localized Strings and Content // -// Copyright (c) 2013, Intel Corporation. All rights reserved.
+// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
// // This program and the accompanying materials are licensed and made available // under the terms and conditions of the BSD License which accompanies this @@ -13,8 +13,8 @@ // // **/ -#string STR_PROPERTIES_MODULE_NAME -#language en-US +#string STR_PROPERTIES_MODULE_NAME +#language en-US "FAT File System Lite PEI Module" diff --git a/FatPkg/FatPei/Part.c b/FatPkg/FatPei/Part.c index 1c1b2896bf..be185460f3 100644 --- a/FatPkg/FatPei/Part.c +++ b/FatPkg/FatPei/Part.c @@ -1,8 +1,8 @@ /** @file - Routines supporting partition discovery and + Routines supporting partition discovery and logical device reading -Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this @@ -22,11 +22,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. This function finds Eltorito partitions. Main algorithm is ported from DXE partition driver. - @param PrivateData The global memory map - @param ParentBlockDevNo The parent block device + @param PrivateData The global memory map + @param ParentBlockDevNo The parent block device - @retval TRUE New partitions are detected and logical block devices - are added to block device array + @retval TRUE New partitions are detected and logical block devices + are added to block device array @retval FALSE No New partitions are added; **/ @@ -40,11 +40,11 @@ FatFindEltoritoPartitions ( This function finds Mbr partitions. Main algorithm is ported from DXE partition driver. - @param PrivateData The global memory map - @param ParentBlockDevNo The parent block device + @param PrivateData The global memory map + @param ParentBlockDevNo The parent block device - @retval TRUE New partitions are detected and logical block devices - are added to block device array + @retval TRUE New partitions are detected and logical block devices + are added to block device array @retval FALSE No New partitions are added; **/ @@ -88,11 +88,11 @@ FatFindPartitions ( This function finds Eltorito partitions. Main algorithm is ported from DXE partition driver. - @param PrivateData The global memory map - @param ParentBlockDevNo The parent block device + @param PrivateData The global memory map + @param ParentBlockDevNo The parent block device - @retval TRUE New partitions are detected and logical block devices - are added to block device array + @retval TRUE New partitions are detected and logical block devices + are added to block device array @retval FALSE No New partitions are added; **/ @@ -309,10 +309,10 @@ FatFindEltoritoPartitions ( /** Test to see if the Mbr buffer is a valid MBR - @param Mbr Parent Handle - @param LastLba Last Lba address on the device. + @param Mbr Parent Handle + @param LastLba Last Lba address on the device. - @retval TRUE Mbr is a Valid MBR + @retval TRUE Mbr is a Valid MBR @retval FALSE Mbr is not a Valid MBR **/ @@ -384,11 +384,11 @@ PartitionValidMbr ( This function finds Mbr partitions. Main algorithm is ported from DXE partition driver. - @param PrivateData The global memory map - @param ParentBlockDevNo The parent block device + @param PrivateData The global memory map + @param ParentBlockDevNo The parent block device - @retval TRUE New partitions are detected and logical block devices - are added to block device array + @retval TRUE New partitions are detected and logical block devices + are added to block device array @retval FALSE No New partitions are added; **/ diff --git a/FatPkg/FatPkg.dsc b/FatPkg/FatPkg.dsc index 841201c245..e856a237f8 100644 --- a/FatPkg/FatPkg.dsc +++ b/FatPkg/FatPkg.dsc @@ -3,7 +3,7 @@ # # This Platform file is used to generate the Binary Fat Drivers # for EDK II Prime release. -# Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.
+# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
# # This program and the accompanying materials are licensed and made available # under the terms and conditions of the BSD License which accompanies this @@ -49,7 +49,7 @@ UefiBootServicesTableLib|MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLib.inf UefiRuntimeServicesTableLib|MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.inf DebugLib|MdePkg/Library/BaseDebugLibNull/BaseDebugLibNull.inf - DebugPrintErrorLevelLib|MdePkg/Library/BaseDebugPrintErrorLevelLib/BaseDebugPrintErrorLevelLib.inf + DebugPrintErrorLevelLib|MdePkg/Library/BaseDebugPrintErrorLevelLib/BaseDebugPrintErrorLevelLib.inf DevicePathLib|MdePkg/Library/UefiDevicePathLib/UefiDevicePathLib.inf [LibraryClasses.common.PEIM] diff --git a/FatPkg/FatPkg.uni b/FatPkg/FatPkg.uni index 262fe9a851..2b04986290 100644 --- a/FatPkg/FatPkg.uni +++ b/FatPkg/FatPkg.uni @@ -2,10 +2,10 @@ // Module implementations for FAT file system, FAT 32 UEFI Driver and FAT PEI Module // // FAT Package -// +// // FAT 32 Driver // -// Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.
+// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
// // This program and the accompanying materials are licensed and made available // under the terms and conditions of the BSD License which accompanies this diff --git a/FatPkg/FatPkgExtra.uni b/FatPkg/FatPkgExtra.uni index 373ddb49a5..ab624e8a05 100644 --- a/FatPkg/FatPkgExtra.uni +++ b/FatPkg/FatPkgExtra.uni @@ -1,7 +1,7 @@ // /** @file // Fat Package Localized Strings and Content. // -// Copyright (c) 2013, Intel Corporation. All rights reserved.
+// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
// // This program and the accompanying materials are licensed and made available // under the terms and conditions of the BSD License which accompanies this @@ -13,8 +13,8 @@ // // **/ -#string STR_PROPERTIES_PACKAGE_NAME -#language en-US +#string STR_PROPERTIES_PACKAGE_NAME +#language en-US "Fat package"