1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
/*++
Copyright (c) 2007 - 2010, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
HiiString.h
Abstract:
EFI_HII_STRING_PROTOCOL from UEFI 2.1 specification.
This protocol provides interfaces to manipulate string data.
Revision History
--*/
#ifndef __EFI_HII_STRING_PROTOCOL_H__
#define __EFI_HII_STRING_PROTOCOL_H__
#include EFI_PROTOCOL_DEFINITION (HiiFont)
//
// Global ID for the Hii String Protocol.
//
#define EFI_HII_STRING_PROTOCOL_GUID \
{ \
0xfd96974, 0x23aa, 0x4cdc, 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a \
}
EFI_FORWARD_DECLARATION (EFI_HII_STRING_PROTOCOL);
typedef
EFI_STATUS
(EFIAPI *EFI_HII_NEW_STRING) (
IN CONST EFI_HII_STRING_PROTOCOL *This,
IN EFI_HII_HANDLE PackageList,
OUT EFI_STRING_ID *StringId,
IN CONST CHAR8 *Language,
IN CONST CHAR16 *LanguageName, OPTIONAL
IN CONST EFI_STRING String,
IN CONST EFI_FONT_INFO *StringFontInfo OPTIONAL
)
/*++
Routine Description:
This function adds the string String to the group of strings owned by PackageList, with the
specified font information StringFontInfo and returns a new string id.
The new string identifier is guaranteed to be unique within the package list.
That new string identifier is reserved for all languages in the package list.
Arguments:
This - A pointer to the EFI_HII_STRING_PROTOCOL instance.
PackageList - Handle of the package list where this string will be added.
StringId - On return, contains the new strings id, which is unique within PackageList.
Language - Points to the language for the new string.
LanguageName - Points to the printable language name to associate with the passed in
Language field.If LanguageName is not NULL and the string package header's LanguageName
associated with a given Language is not zero, the LanguageName being passed
in will be ignored.
String - Points to the new null-terminated string.
StringFontInfo - Points to the new string¡¯s font information or NULL if the string should have the
default system font, size and style.
Returns:
EFI_SUCCESS - The new string was added successfully.
EFI_NOT_FOUND - The specified PackageList could not be found in database.
EFI_OUT_OF_RESOURCES - Could not add the string due to lack of resources.
EFI_INVALID_PARAMETER - String is NULL or StringId is NULL or Language is NULL.
--*/
;
typedef
EFI_STATUS
(EFIAPI *EFI_HII_GET_STRING) (
IN CONST EFI_HII_STRING_PROTOCOL *This,
IN CONST CHAR8 *Language,
IN EFI_HII_HANDLE PackageList,
IN EFI_STRING_ID StringId,
OUT EFI_STRING String,
IN OUT UINTN *StringSize,
OUT EFI_FONT_INFO **StringFontInfo OPTIONAL
)
/*++
Routine Description:
This function retrieves the string specified by StringId which is associated
with the specified PackageList in the language Language and copies it into
the buffer specified by String.
Arguments:
This - A pointer to the EFI_HII_STRING_PROTOCOL instance.
Language - Points to the language for the retrieved string.
PackageList - The package list in the HII database to search for the
specified string.
StringId - The string's id, which is unique within PackageList.
String - Points to the new null-terminated string.
StringSize - On entry, points to the size of the buffer pointed to by
String, in bytes. On return,
points to the length of the string, in bytes.
StringFontInfo - Points to a buffer that will be callee allocated and will
have the string's font information into this buffer.
The caller is responsible for freeing this buffer.
If the parameter is NULL a buffer will not be allocated
and the string font information will not be returned.
Returns:
EFI_SUCCESS - The string was returned successfully.
EFI_NOT_FOUND - The string specified by StringId is not available.
The specified PackageList is not in the database.
EFI_INVALID_LANGUAGE - The string specified by StringId is available but
not in the specified language.
EFI_BUFFER_TOO_SMALL - The buffer specified by StringSize is too small to
hold the string.
EFI_INVALID_PARAMETER - The String or Language or StringSize was NULL.
EFI_OUT_OF_RESOURCES - There were insufficient resources to complete the
request.
--*/
;
typedef
EFI_STATUS
(EFIAPI *EFI_HII_SET_STRING) (
IN CONST EFI_HII_STRING_PROTOCOL *This,
IN EFI_HII_HANDLE PackageList,
IN EFI_STRING_ID StringId,
IN CONST CHAR8 *Language,
IN CONST EFI_STRING String,
IN CONST EFI_FONT_INFO *StringFontInfo OPTIONAL
)
/*++
Routine Description:
This function updates the string specified by StringId in the specified PackageList to the text
specified by String and, optionally, the font information specified by StringFontInfo.
Arguments:
This - A pointer to the EFI_HII_STRING_PROTOCOL instance.
PackageList - The package list containing the strings.
StringId - The string¡¯s id, which is unique within PackageList.
Language - Points to the language for the updated string.
String - Points to the new null-terminated string.
StringFontInfo - Points to the string¡¯s font information or NULL if the string font information is not
changed.
Returns:
EFI_SUCCESS - The string was updated successfully.
EFI_NOT_FOUND - The string specified by StringId is not in the database.
The specified PackageList is not in the database.
EFI_INVALID_PARAMETER - The String or Language was NULL.
EFI_OUT_OF_RESOURCES - The system is out of resources to accomplish the task.
--*/
;
typedef
EFI_STATUS
(EFIAPI *EFI_HII_GET_LANGUAGES) (
IN CONST EFI_HII_STRING_PROTOCOL *This,
IN EFI_HII_HANDLE PackageList,
IN OUT CHAR8 *Languages,
IN OUT UINTN *LanguagesSize
)
/*++
Routine Description:
This function returns the list of supported languages, in the format specified
in Appendix M of UEFI 2.1 spec.
Arguments:
This - A pointer to the EFI_HII_STRING_PROTOCOL instance.
PackageList - The package list to examine.
Languages - Points to the buffer to hold the returned string.
LanguagesSize - On entry, points to the size of the buffer pointed to by
Languages, in bytes. On
return, points to the length of Languages, in bytes.
Returns:
EFI_SUCCESS - The languages were returned successfully.
EFI_INVALID_PARAMETER - The Languages or LanguagesSize was NULL.
EFI_BUFFER_TOO_SMALL - The LanguagesSize is too small to hold the list of
supported languages. LanguageSize is updated to
contain the required size.
EFI_NOT_FOUND - The specified PackageList is not in the database.
--*/
;
typedef
EFI_STATUS
(EFIAPI *EFI_HII_GET_2ND_LANGUAGES) (
IN CONST EFI_HII_STRING_PROTOCOL *This,
IN EFI_HII_HANDLE PackageList,
IN CONST CHAR8 *FirstLanguage,
IN OUT CHAR8 *SecondLanguages,
IN OUT UINTN *SecondLanguagesSize
)
/*++
Routine Description:
Each string package has associated with it a single primary language and zero
or more secondary languages. This routine returns the secondary languages
associated with a package list.
Arguments:
This - A pointer to the EFI_HII_STRING_PROTOCOL instance.
PackageList - The package list to examine.
FirstLanguage - Points to the primary language.
SecondaryLanguages - Points to the buffer to hold the returned list of
secondary languages for the specified FirstLanguage.
If there are no secondary languages, the function
returns successfully, but this is set to NULL.
SecondaryLanguageSize - On entry, points to the size of the buffer pointed to
by SecondLanguages, in bytes. On return, points to
the length of SecondLanguages in bytes.
Returns:
EFI_SUCCESS - Secondary languages were correctly returned.
EFI_INVALID_PARAMETER - FirstLanguage or SecondLanguages or SecondLanguagesSize was NULL.
EFI_BUFFER_TOO_SMALL - The buffer specified by SecondLanguagesSize is
too small to hold the returned information.
SecondLanguageSize is updated to hold the size of
the buffer required.
EFI_INVALID_LANGUAGE - The language specified by FirstLanguage is not
present in the specified package list.
EFI_NOT_FOUND - The specified PackageList is not in the Database.
--*/
;
//
// Interface structure for the EFI_HII_STRING_PROTOCOL
//
typedef struct _EFI_HII_STRING_PROTOCOL {
EFI_HII_NEW_STRING NewString;
EFI_HII_GET_STRING GetString;
EFI_HII_SET_STRING SetString;
EFI_HII_GET_LANGUAGES GetLanguages;
EFI_HII_GET_2ND_LANGUAGES GetSecondaryLanguages;
} EFI_HII_STRING_PROTOCOL;
extern EFI_GUID gEfiHiiStringProtocolGuid;
#endif
|
