]>
Commit | Line | Data |
---|---|---|
9226efe5 | 1 | /** @file\r |
2 | Library header file defines APIs that is related to IFR operations but \r | |
3 | specific to EDK II implementation.\r | |
4 | \r | |
1e354c03 | 5 | Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r |
6 | All rights reserved. This program and the accompanying materials\r | |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
9226efe5 | 13 | \r |
14 | **/\r | |
15 | \r | |
16 | #ifndef __EXTENDED_IFR_SUPPORT_LIB_H__\r | |
17 | #define __EXTENDED_IFR_SUPPORT_LIB_H__\r | |
18 | \r | |
19 | /**\r | |
20 | Create GUIDed opcode for banner. Banner opcode\r | |
21 | EFI_IFR_EXTEND_OP_BANNER is extended opcode specific\r | |
22 | to Intel's implementation.\r | |
23 | \r | |
24 | @param Title String ID for title\r | |
25 | @param LineNumber Line number for this banner\r | |
26 | @param Alignment Alignment for this banner, left, center or right\r | |
27 | @param Data Destination for the created opcode binary\r | |
28 | \r | |
29 | @retval EFI_SUCCESS Opcode create success\r | |
30 | @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r | |
31 | \r | |
32 | **/\r | |
33 | EFI_STATUS\r | |
5f597758 | 34 | EFIAPI\r |
9226efe5 | 35 | CreateBannerOpCode (\r |
36 | IN EFI_STRING_ID Title,\r | |
37 | IN UINT16 LineNumber,\r | |
38 | IN UINT8 Alignment,\r | |
39 | IN OUT EFI_HII_UPDATE_DATA *Data\r | |
ed66e1bc | 40 | );\r |
9226efe5 | 41 | \r |
42 | /**\r | |
43 | This function allows the caller to update a form that has\r | |
44 | previously been registered with the EFI HII database.\r | |
45 | The update make use of a extended opcode EFI_IFR_EXTEND_OP_LABEL\r | |
46 | specific to Intel's implementation to complete the operation.\r | |
47 | \r | |
48 | \r | |
49 | @param Handle Hii Handle\r | |
50 | @param FormSetGuid The formset should be updated.\r | |
51 | @param FormId The form should be updated.\r | |
52 | @param Label Update information starting immediately after this\r | |
53 | label in the IFR\r | |
54 | @param Insert If TRUE and Data is not NULL, insert data after\r | |
55 | Label. If FALSE, replace opcodes between two\r | |
56 | labels with Data.\r | |
57 | @param Data The adding data; If NULL, remove opcodes between\r | |
58 | two Label.\r | |
59 | \r | |
60 | @retval EFI_SUCCESS Update success.\r | |
61 | @retval Other Update fail.\r | |
62 | \r | |
63 | **/\r | |
64 | EFI_STATUS\r | |
5f597758 | 65 | EFIAPI\r |
9226efe5 | 66 | IfrLibUpdateForm (\r |
67 | IN EFI_HII_HANDLE Handle,\r | |
68 | IN EFI_GUID *FormSetGuid, OPTIONAL\r | |
69 | IN EFI_FORM_ID FormId,\r | |
70 | IN UINT16 Label,\r | |
71 | IN BOOLEAN Insert,\r | |
72 | IN EFI_HII_UPDATE_DATA *Data\r | |
ed66e1bc | 73 | );\r |
9226efe5 | 74 | \r |
75 | /**\r | |
76 | Extract formset class for given HII handle.\r | |
77 | \r | |
78 | If Handle is not a valid EFI_HII_HANDLE in the default HII database, then\r | |
79 | ASSERT.\r | |
80 | \r | |
81 | If Class is NULL, then ASSERT.\r | |
82 | IfFormSetTitle is NULL, then ASSERT.\r | |
83 | If FormSetHelp is NULL, then ASSERT.\r | |
84 | \r | |
85 | @param HiiHandle Hii handle\r | |
86 | @param Class On output, Class of the formset\r | |
87 | @param FormSetTitle On output, Formset title string\r | |
88 | @param FormSetHelp On output, Formset help string\r | |
89 | \r | |
90 | @retval EFI_SUCCESS Successfully extract Class for specified Hii\r | |
91 | handle.\r | |
92 | \r | |
93 | **/\r | |
94 | EFI_STATUS\r | |
5f597758 | 95 | EFIAPI\r |
9226efe5 | 96 | IfrLibExtractClassFromHiiHandle (\r |
97 | IN EFI_HII_HANDLE Handle,\r | |
98 | OUT UINT16 *Class,\r | |
99 | OUT EFI_STRING_ID *FormSetTitle,\r | |
100 | OUT EFI_STRING_ID *FormSetHelp\r | |
ed66e1bc | 101 | );\r |
9226efe5 | 102 | \r |
103 | /**\r | |
104 | Configure the buffer accrording to ConfigBody strings in the format of\r | |
105 | <Length:4 bytes>, <Offset: 2 bytes>, <Width:2 bytes>, <Data:n bytes>.\r | |
106 | \r | |
107 | @param Buffer the start address of buffer.\r | |
108 | @param BufferSize the size of buffer.\r | |
5f597758 LG |
109 | @param Number the number of the ConfigBody strings.\r |
110 | @param ... the ConfigBody strings\r | |
9226efe5 | 111 | \r |
112 | @retval EFI_BUFFER_TOO_SMALL the BufferSize is too small to operate.\r | |
113 | @retval EFI_INVALID_PARAMETER Buffer is NULL or BufferSize is 0.\r | |
114 | @retval EFI_SUCCESS Operation successful.\r | |
115 | \r | |
116 | **/\r | |
117 | EFI_STATUS\r | |
118 | EFIAPI\r | |
119 | IfrLibExtractDefault(\r | |
120 | IN VOID *Buffer,\r | |
121 | IN UINTN *BufferSize,\r | |
122 | UINTN Number,\r | |
123 | ...\r | |
ed66e1bc | 124 | );\r |
9226efe5 | 125 | \r |
126 | #endif\r | |
127 | \r |