summaryrefslogtreecommitdiff
path: root/Core/CORE_DXE/FrameworkHii/FrameworkHiiUtils.c
blob: c0ec1b8172861c70e372246d53ac7c619338852d (plain)
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (C)Copyright 1985-2010, American Megatrends, Inc.         **
//**                                                                  **
//**                       All Rights Reserved.                       **
//**                                                                  **
//**      5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093        **
//**                                                                  **
//**                       Phone: (770)-246-8600                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************

//**********************************************************************
// $Header: /Alaska/SOURCE/Core/CORE_DXE/FrameworkHii/FrameworkHiiUtils.c 3     2/23/10 10:17p Felixp $
//
// $Revision: 3 $
//
// $Date: 2/23/10 10:17p $
//**********************************************************************
// Revision History
// ----------------
// $Log: /Alaska/SOURCE/Core/CORE_DXE/FrameworkHii/FrameworkHiiUtils.c $
// 
// 3     2/23/10 10:17p Felixp
// SetBrowserData function is added
// 
// 2     11/24/09 10:40a Felixp
// 
// 1     10/09/09 6:10p Felixp
// 
//**********************************************************************
//<AMI_FHDR_START>
//
// Name:	UefiHiiUtils.c
//
// Description:	Framework HII 0.91 HII Utilities Protocol Implementation
//
//<AMI_FHDR_END>
//**********************************************************************
#include <AmiDxeLib.h>
#include <Protocol/HiiUtilities.h>
#include <Protocol/LoadedImage.h>
#include <Protocol/DevicePath.h>

static EFI_HII_PROTOCOL *Hii=NULL;
static EFI_GUID HiiResourcesFfsSectionGuid= HII_RESOURCES_FFS_SECTION_GUID;

//*************************************************************************
//<AMI_PHDR_START>
//
// Name: SetCallback
//
// Description:
//  EFI_STATUS SetCallback(EFI_HII_IFR_PACK *pIfr,
// UINTN NumberOfCallbacks, CALLBACK_INFO *CallbackInfo,
// CALLBACK_INFO **CallBackFound)
//
// Input:
//
// Output:
//
// Modified:
//
// Referrals:
// 
// Notes:	
//          
//<AMI_PHDR_END>
//*************************************************************************
static EFI_STATUS SetCallback(
    EFI_LOADED_IMAGE_PROTOCOL *Image,
	EFI_IFR_FORM_SET *FormSet, UINTN NumberOfCallbacks,
	CALLBACK_INFO *CallbackInfo, CALLBACK_INFO **CallBackFound,
    EFI_HANDLE *CallbackHandle 
)
{
	UINTN i;
	EFI_STATUS Status;
	for(i=0; i<NumberOfCallbacks; i++)
	{
		if (
			   FormSet->Class==CallbackInfo[i].Class
			&& FormSet->SubClass==CallbackInfo[i].SubClass
			&& (!CallbackInfo[i].pGuid || !guidcmp(&FormSet->Guid,CallbackInfo[i].pGuid))
		)
		{
			if (CallbackInfo[i].pFormCallback)
			{
				EFI_HANDLE Handle=NULL;
				Status=pBS->InstallProtocolInterface(&Handle, &gEfiFormCallbackProtocolGuid, EFI_NATIVE_INTERFACE, CallbackInfo[i].pFormCallback);
				if (EFI_ERROR(Status)) return Status;
				FormSet->CallbackHandle=(EFI_PHYSICAL_ADDRESS)Handle;
                if (CallbackHandle) *CallbackHandle=Handle;
			}
			if (CallBackFound) *CallBackFound=&CallbackInfo[i];
			return EFI_SUCCESS;
		}
	}
	if (CallBackFound) *CallBackFound=NULL;
	return EFI_NOT_FOUND;
}

static EFI_STATUS PublishPackages(
    IN VOID *PackagePointers, IN UINTN NumberOfPackages, 
    IN EFI_GUID *PackageGuid, IN EFI_HANDLE DriverHandle OPTIONAL,
    OUT EFI_HII_HANDLE *HiiHandle
){
    EFI_STATUS Status;
	EFI_HII_PACKAGES *PackageList;
    EFI_HII_PACK_HEADER **Packages = PackagePointers;
    
    if (   !Hii 
        && EFI_ERROR(Status=pBS->LocateProtocol(
                        &gEfiHiiProtocolGuid, NULL, &Hii
           ))
    ) return Status;

	PackageList = Malloc(
        sizeof(EFI_HII_PACKAGES)+sizeof(EFI_HII_PACK_HEADER*)*NumberOfPackages
    );
    if(PackageList==NULL) return EFI_OUT_OF_RESOURCES;
    PackageList->NumberOfPackages=NumberOfPackages;
	PackageList->GuidId = PackageGuid;
	pBS->CopyMem(
        PackageList+1, Packages, sizeof(EFI_HII_PACK_HEADER*)*NumberOfPackages
    );
	Status = Hii->NewPack(Hii, PackageList, HiiHandle);
    pBS->FreePool(PackageList);
    return Status;
}

//*************************************************************************
//<AMI_PHDR_START>
//
// Name: LoadStrings
//
// Description:
//  EFI_STATUS LoadStrings(EFI_HANDLE ImageHandle,
// EFI_HII_HANDLE *HiiHandle)
//
// Input:
//
// Output:
//
// Modified:
//
// Referrals:
// 
// Notes:	
//          
//<AMI_PHDR_END>
//*************************************************************************
static EFI_STATUS LoadStrings(
	EFI_HANDLE ImageHandle, EFI_HII_HANDLE *HiiHandle
)
{
	EFI_STATUS Status;
	EFI_LOADED_IMAGE_PROTOCOL *Image;
	HII_RESOURCE_SECTION_HEADER *pSection;
	UINTN SectionSize;
	EFI_HII_PACK_HEADER *pPack;

	if (EFI_ERROR(Status=pBS->HandleProtocol(
                        ImageHandle, &gEfiLoadedImageProtocolGuid, &Image
        ))
    ) return Status;
#if defined(EMBEDDED_RESOURCES) && EMBEDDED_RESOURCES==1
{
#define AMIRC_PESECTION_NAME 0x5f534552494d415f//_AMIRES_
	UINT8 *pData;
	pData = FindPeSection(Image->ImageBase, AMIRC_PESECTION_NAME, &SectionSize);
	if (!pData) return EFI_NOT_FOUND;
	pSection = Malloc(SectionSize);
	pBS->CopyMem(pSection,pData,SectionSize);
    Status = EFI_SUCCESS;
}
#else
{
	Status=ReadImageResource(ImageHandle,&HiiResourcesFfsSectionGuid,&pSection,&SectionSize);
	if (EFI_ERROR(Status)) return Status;
}
#endif
    pPack = (EFI_HII_PACK_HEADER*)(pSection+1);
    if (pPack->Type == EFI_HII_STRING){
        Status = PublishPackages(
            &pPack, 1, 
            &((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH*)(Image->FilePath))->NameGuid,
            NULL, HiiHandle
        );
    }else{
		Status = EFI_INVALID_PARAMETER;
	}
	pBS->FreePool(pSection);
	return Status;	
}

//*************************************************************************
//<AMI_PHDR_START>
//
// Name: LoadResources
//
// Description:
//  EFI_STATUS LoadResources(EFI_HANDLE ImageHandle,
// UINTN NumberOfCallbacks, CALLBACK_INFO *CallbackInfo,
// INIT_HII_PACK InitFunction)
//
// Input:
//
// Output:
//
// Modified:
//
// Referrals:
// 
// Notes:	
//          
//<AMI_PHDR_END>
//*************************************************************************
static EFI_STATUS LoadResources(
	EFI_HANDLE ImageHandle, UINTN NumberOfCallbacks,
	CALLBACK_INFO *CallbackInfo, INIT_HII_PACK InitFunction
)
{
	EFI_STATUS Status;
	EFI_HII_HANDLE HiiHandle;
	EFI_LOADED_IMAGE_PROTOCOL *Image;
	HII_RESOURCE_SECTION_HEADER *pSection;
	UINTN SectionSize;
	CALLBACK_INFO *pCallBackFound;
	if (EFI_ERROR(Status=pBS->HandleProtocol(ImageHandle, &gEfiLoadedImageProtocolGuid, &Image))) return Status;
#if defined(EMBEDDED_RESOURCES) && EMBEDDED_RESOURCES==1
{
#define AMIRC_PESECTION_NAME 0x5f534552494d415f//_AMIRES_
	UINT8 *pData;
	pData = FindPeSection(Image->ImageBase, AMIRC_PESECTION_NAME, &SectionSize);
	if (!pData) return EFI_NOT_FOUND;
	pSection = Malloc(SectionSize);
	pBS->CopyMem(pSection,pData,SectionSize);
}
#else
{
	Status=ReadImageResource(ImageHandle,&HiiResourcesFfsSectionGuid,&pSection,&SectionSize);
	if (EFI_ERROR(Status)) return Status;
}
#endif
{
    EFI_HII_PACK_HEADER **IfrPackagPtr, **GlobalPackagPtr, **SharedPackagPtr;
    UINTN NumberOfIfrPackages, NumberOfGlobalPackages, NumberOfSharedPackages, i;
    UINT8 *PackagePtrBuffer;
    EFI_HII_PACK_HEADER *PackagePtr;

    PackagePtrBuffer = Malloc(3*pSection->NumberOfPackages*sizeof(EFI_HII_PACK_HEADER*));
    IfrPackagPtr = (EFI_HII_PACK_HEADER**)PackagePtrBuffer;
    GlobalPackagPtr = IfrPackagPtr+pSection->NumberOfPackages;
    SharedPackagPtr = GlobalPackagPtr+pSection->NumberOfPackages;
    NumberOfIfrPackages = 0;
    NumberOfGlobalPackages = 0;
    NumberOfSharedPackages = 0;

    PackagePtr = (EFI_HII_PACK_HEADER*)(pSection+1);
	while(PackagePtr < (EFI_HII_PACK_HEADER*)((UINT8*)pSection+SectionSize)){
		switch(PackagePtr->Type){
        case EFI_HII_IFR:
            IfrPackagPtr[NumberOfIfrPackages++]=PackagePtr;
            break;
        case EFI_HII_FONT: case EFI_HII_KEYBOARD:
            GlobalPackagPtr[NumberOfGlobalPackages++]=PackagePtr;
            break;
        default:
            SharedPackagPtr[NumberOfSharedPackages++]=PackagePtr;
            if (PackagePtr->Type==EFI_HII_STRING){
			    while(PackagePtr->Length)
				    PackagePtr = (EFI_HII_PACK_HEADER*)((UINT8*)PackagePtr+PackagePtr->Length);
                PackagePtr = (EFI_HII_PACK_HEADER*)((UINT8*)PackagePtr+sizeof(EFI_HII_STRING_PACK));
                continue;
            }
            break;
        }
        PackagePtr = (EFI_HII_PACK_HEADER*)((UINT8*)PackagePtr+PackagePtr->Length);
    }
    Status = PublishPackages(
        GlobalPackagPtr, NumberOfGlobalPackages,
        &((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH*)(Image->FilePath))->NameGuid,
        NULL, &HiiHandle
    );
    for(i=0; i<NumberOfIfrPackages; i++){
        EFI_HANDLE CallbackHandle;

        SharedPackagPtr[NumberOfSharedPackages]=IfrPackagPtr[i];
        SetCallback(
            Image, (EFI_IFR_FORM_SET*)(IfrPackagPtr[i]+1),
            NumberOfCallbacks,CallbackInfo,&pCallBackFound,&CallbackHandle
        );
        Status = PublishPackages(
            SharedPackagPtr, NumberOfSharedPackages+1, 
            &((EFI_IFR_FORM_SET*)(IfrPackagPtr[i]+1))->Guid,
            CallbackHandle, &HiiHandle
        );
		if (pCallBackFound) pCallBackFound->HiiHandle=HiiHandle;
		if (InitFunction) InitFunction(HiiHandle,pCallBackFound);
		pCallBackFound=NULL;
    }
    pBS->FreePool(PackagePtrBuffer);
	pBS->FreePool(pSection);
}
	return EFI_SUCCESS;	
}

//TODO: header
static EFI_STATUS GetString(
	IN EFI_HII_HANDLE HiiHandle, IN STRING_REF StringId, 
	IN OUT UINTN *StringSize, OUT EFI_STRING String
){
    if (   !Hii 
        && EFI_ERROR(pBS->LocateProtocol(&gEfiHiiProtocolGuid, NULL, &Hii))
    ) return EFI_NOT_FOUND;
    return Hii->GetString(
        Hii, HiiHandle, StringId, TRUE, NULL, StringSize, String
    );
}

//TODO header
static EFI_STATUS SetString(
	IN EFI_HII_HANDLE HiiHandle, IN STRING_REF StringId, IN EFI_STRING String
){
    if (   !Hii 
        && EFI_ERROR(pBS->LocateProtocol(&gEfiHiiProtocolGuid, NULL, &Hii))
    ) return EFI_NOT_FOUND;
    return Hii->NewString(
        Hii, L"   ", HiiHandle, &StringId, String
    );
}

static EFI_STATUS GetBrowserData(
    IN UINTN *BufferSize, OUT VOID *Buffer, 
    IN CONST EFI_GUID *VarStoreGuid, OPTIONAL 
    IN CONST CHAR16 *VarStoreName  OPTIONAL
){
    return EFI_UNSUPPORTED;
}

static EFI_STATUS SetBrowserData(
    IN UINTN BufferSize, IN VOID *Buffer, 
    IN CONST EFI_GUID *VarStoreGuid, OPTIONAL 
    IN CONST CHAR16 *VarStoreName  OPTIONAL
){
    return EFI_UNSUPPORTED;
}

HII_UTILITIES_PROTOCOL HiiUtilitiesProtocol = {
    LoadResources, LoadStrings, PublishPackages, 
    GetBrowserData, SetBrowserData, GetString, SetString
};

//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (C)Copyright 1985-2010, American Megatrends, Inc.         **
//**                                                                  **
//**                       All Rights Reserved.                       **
//**                                                                  **
//**      5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093        **
//**                                                                  **
//**                       Phone: (770)-246-8600                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************