]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Core/Dxe/FwVol/FwVolWrite.c
Add doxygen style comments for functions in DxeMain.
[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
20 /**
21 Writes one or more files to the firmware volume.
22
23 @param This Indicates the calling context.
24 @param NumberOfFiles Number of files.
25 @param WritePolicy WritePolicy indicates the level of reliability
26 for the write in the event of a power failure or
27 other system failure during the write operation.
28 @param FileData FileData is an pointer to an array of
29 EFI_FV_WRITE_DATA. Each element of array
30 FileData represents a file to be written.
31
32 @retval EFI_SUCCESS Files successfully written to firmware volume
33 @retval EFI_OUT_OF_RESOURCES Not enough buffer to be allocated.
34 @retval EFI_DEVICE_ERROR Device error.
35 @retval EFI_WRITE_PROTECTED Write protected.
36 @retval EFI_NOT_FOUND Not found.
37 @retval EFI_INVALID_PARAMETER Invalid parameter.
38 @retval EFI_UNSUPPORTED This function not supported.
39
40 **/
41 EFI_STATUS
42 EFIAPI
43 FvWriteFile (
44 IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This,
45 IN UINT32 NumberOfFiles,
46 IN EFI_FV_WRITE_POLICY WritePolicy,
47 IN EFI_FV_WRITE_FILE_DATA *FileData
48 )
49 {
50 return EFI_UNSUPPORTED;
51 }
52
53