2 Header file for Function and Macro defintions for to extract default values from UEFI Form package.
4 Copyright (c) 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _HII_THUNK_UEFI_IFR_DEFAULT_
16 #define _HII_THUNK_UEFI_IFR_DEFAULT_
18 #define UEFI_IFR_BUFFER_STORAGE_NODE_FROM_LIST(a) CR(a, UEFI_IFR_BUFFER_STORAGE_NODE, List, UEFI_IFR_BUFFER_STORAGE_NODE_SIGNATURE)
19 #define UEFI_IFR_BUFFER_STORAGE_NODE_SIGNATURE SIGNATURE_32 ('I', 'b', 'S', 'n')
31 } UEFI_IFR_BUFFER_STORAGE_NODE
;
34 Get the default value for Buffer Type storage from the first FormSet
35 in the Package List specified by a EFI_HII_HANDLE.
37 The results can be multiple instances of UEFI_IFR_BUFFER_STORAGE_NODE.
38 They are inserted to the link list.
40 @param UefiHiiHandle The handle for the package list.
41 @param UefiDefaultsListHead The head of link list for the output.
43 @retval EFI_SUCCESS Successful.
47 UefiIfrGetBufferTypeDefaults (
48 IN HII_THUNK_CONTEXT
*ThunkContext
,
49 OUT LIST_ENTRY
**UefiDefaults
53 Convert the UEFI Buffer Type default values to a Framework HII default
54 values specified by a EFI_HII_VARIABLE_PACK_LIST structure.
56 @param ListHead The link list of UEFI_IFR_BUFFER_STORAGE_NODE
57 which contains the default values retrived from
59 @param DefaultMask The default mask.
60 The valid values are FRAMEWORK_EFI_IFR_FLAG_DEFAULT
61 and FRAMEWORK_EFI_IFR_FLAG_MANUFACTURING.
62 UEFI spec only map FRAMEWORK_EFI_IFR_FLAG_DEFAULT and FRAMEWORK_EFI_IFR_FLAG_MANUFACTURING
63 from specification to valid default class.
64 @param VariablePackList The output default value in a format defined in Framework.
67 @retval EFI_SUCCESS Successful.
68 @retval EFI_INVALID_PARAMETER The default mask is not FRAMEWORK_EFI_IFR_FLAG_DEFAULT or
69 FRAMEWORK_EFI_IFR_FLAG_MANUFACTURING.
73 UefiDefaultsToFwDefaults (
74 IN LIST_ENTRY
*UefiIfrDefaults
,
76 IN EFI_VARSTORE_ID UefiFormSetDefaultVarStoreId
,
77 OUT EFI_HII_VARIABLE_PACK_LIST
**VariablePackList
81 Free up all buffer allocated for the link list of UEFI_IFR_BUFFER_STORAGE_NODE.
83 @param ListHead The link list of UEFI_IFR_BUFFER_STORAGE_NODE
84 which contains the default values retrived from
88 @retval EFI_SUCCESS Successful.
89 @retval EFI_INVALID_PARAMETER The default mask is not FRAMEWORK_EFI_IFR_FLAG_DEFAULT or
90 FRAMEWORK_EFI_IFR_FLAG_MANUFACTURING.
94 IN LIST_ENTRY
*UefiIfrDefaults