]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Core/Dxe/FwVol/FwVolWrite.c
Add comments and DoxyGen format for these files.
[mirror_edk2.git] / MdeModulePkg / Core / Dxe / FwVol / FwVolWrite.c
CommitLineData
504214c4
LG
1/** @file \r
2\r
3 Implements functions to write firmware file\r
28a00297 4\r
504214c4 5Copyright (c) 2006 - 2008, Intel Corporation \r
28a00297 6All rights reserved. This program and the accompanying materials \r
7are licensed and made available under the terms and conditions of the BSD License \r
8which accompanies this distribution. The full text of the license may be found at \r
9http://opensource.org/licenses/bsd-license.php \r
10 \r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
13\r
504214c4 14**/\r
28a00297 15\r
16#include <DxeMain.h>\r
17\r
18\r
19EFI_STATUS\r
20EFIAPI\r
21FvWriteFile (\r
0c2b5da8 22 IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
23 IN UINT32 NumberOfFiles,\r
24 IN EFI_FV_WRITE_POLICY WritePolicy,\r
25 IN EFI_FV_WRITE_FILE_DATA *FileData\r
28a00297 26 )\r
27/*++\r
28\r
29 Routine Description:\r
30 Writes one or more files to the firmware volume.\r
31\r
32 Arguments:\r
33 This - Indicates the calling context.\r
34 NumberOfFiles - Number of files.\r
35 WritePolicy - WritePolicy indicates the level of reliability for\r
36 the write in the event of a power failure or other\r
37 system failure during the write operation.\r
38 FileData - FileData is an pointer to an array of EFI_FV_WRITE_DATA.\r
39 Each element of FileData[] represents a file to be written.\r
40\r
41 Returns:\r
42 EFI_SUCCESS - Files successfully written to firmware volume\r
43 EFI_OUT_OF_RESOURCES - Not enough buffer to be allocated.\r
44 EFI_DEVICE_ERROR - Device error.\r
45 EFI_WRITE_PROTECTED - Write protected.\r
46 EFI_NOT_FOUND - Not found.\r
47 EFI_INVALID_PARAMETER - Invalid parameter.\r
48 EFI_UNSUPPORTED - This function not supported.\r
49\r
50--*/\r
51{ \r
52 return EFI_UNSUPPORTED;\r
53}\r
54\r