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