Fix typo in comment.
[mirror_edk2.git] / IntelFrameworkPkg / Library / FrameworkUefiLib / UefiLib.c
1 /** @file
2 Implementation of UefiLib
3
4 Copyright (c) 2006 - 2007, Intel Corporation<BR>
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
9
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.
12
13 **/
14
15 #include "FrameworkUefiLib.h"
16
17 /**
18 Compare whether two names of languages are identical.
19
20 @param Language1 Name of language 1.
21 @param Language2 Name of language 2.
22
23 @retval TRUE Language 1 and language 2 are the same.
24 @retval FALSE Language 1 and language 2 are not the same.
25
26 **/
27 STATIC
28 BOOLEAN
29 CompareIso639LanguageCode (
30 IN CONST CHAR8 *Language1,
31 IN CONST CHAR8 *Language2
32 )
33 {
34 UINT32 Name1;
35 UINT32 Name2;
36
37 Name1 = ReadUnaligned24 ((CONST UINT32 *) Language1);
38 Name2 = ReadUnaligned24 ((CONST UINT32 *) Language2);
39
40 return (BOOLEAN) (Name1 == Name2);
41 }
42
43 /**
44 This function searches the list of configuration tables stored in the EFI System
45 Table for a table with a GUID that matches TableGuid. If a match is found,
46 then a pointer to the configuration table is returned in Table, and EFI_SUCCESS
47 is returned. If a matching GUID is not found, then EFI_NOT_FOUND is returned.
48
49 @param TableGuid Pointer to table's GUID type..
50 @param Table Pointer to the table associated with TableGuid in the EFI System Table.
51
52 @retval EFI_SUCCESS A configuration table matching TableGuid was found.
53 @retval EFI_NOT_FOUND A configuration table matching TableGuid could not be found.
54
55 **/
56 EFI_STATUS
57 EFIAPI
58 EfiGetSystemConfigurationTable (
59 IN EFI_GUID *TableGuid,
60 OUT VOID **Table
61 )
62 {
63 EFI_SYSTEM_TABLE *SystemTable;
64 UINTN Index;
65
66 ASSERT (TableGuid != NULL);
67 ASSERT (Table != NULL);
68
69 SystemTable = gST;
70 *Table = NULL;
71 for (Index = 0; Index < SystemTable->NumberOfTableEntries; Index++) {
72 if (CompareGuid (TableGuid, &(SystemTable->ConfigurationTable[Index].VendorGuid))) {
73 *Table = SystemTable->ConfigurationTable[Index].VendorTable;
74 return EFI_SUCCESS;
75 }
76 }
77
78 return EFI_NOT_FOUND;
79 }
80
81 /**
82 This function causes the notification function to be executed for every protocol
83 of type ProtocolGuid instance that exists in the system when this function is
84 invoked. In addition, every time a protocol of type ProtocolGuid instance is
85 installed or reinstalled, the notification function is also executed.
86
87 @param ProtocolGuid Supplies GUID of the protocol upon whose installation the event is fired.
88 @param NotifyTpl Supplies the task priority level of the event notifications.
89 @param NotifyFunction Supplies the function to notify when the event is signaled.
90 @param NotifyContext The context parameter to pass to NotifyFunction.
91 @param Registration A pointer to a memory location to receive the registration value.
92
93 @return The notification event that was created.
94
95 **/
96 EFI_EVENT
97 EFIAPI
98 EfiCreateProtocolNotifyEvent(
99 IN EFI_GUID *ProtocolGuid,
100 IN EFI_TPL NotifyTpl,
101 IN EFI_EVENT_NOTIFY NotifyFunction,
102 IN VOID *NotifyContext, OPTIONAL
103 OUT VOID **Registration
104 )
105 {
106 EFI_STATUS Status;
107 EFI_EVENT Event;
108
109 //
110 // Create the event
111 //
112
113 Status = gBS->CreateEvent (
114 EVT_NOTIFY_SIGNAL,
115 NotifyTpl,
116 NotifyFunction,
117 NotifyContext,
118 &Event
119 );
120 ASSERT_EFI_ERROR (Status);
121
122 //
123 // Register for protocol notifactions on this event
124 //
125
126 Status = gBS->RegisterProtocolNotify (
127 ProtocolGuid,
128 Event,
129 Registration
130 );
131
132 ASSERT_EFI_ERROR (Status);
133
134 //
135 // Kick the event so we will perform an initial pass of
136 // current installed drivers
137 //
138
139 gBS->SignalEvent (Event);
140 return Event;
141 }
142
143 /**
144 This function creates an event using NotifyTpl, NoifyFunction, and NotifyContext.
145 This event is signaled with EfiNamedEventSignal(). This provide the ability for
146 one or more listeners on the same event named by the GUID specified by Name.
147
148 @param Name Supplies GUID name of the event.
149 @param NotifyTpl Supplies the task priority level of the event notifications.
150 @param NotifyFunction Supplies the function to notify when the event is signaled.
151 @param NotifyContext The context parameter to pass to NotifyFunction.
152 @param Registration A pointer to a memory location to receive the registration value.
153
154 @retval EFI_SUCCESS A named event was created.
155 @retval EFI_OUT_OF_RESOURCES There are not enough resource to create the named event.
156
157 **/
158 EFI_STATUS
159 EFIAPI
160 EfiNamedEventListen (
161 IN CONST EFI_GUID *Name,
162 IN EFI_TPL NotifyTpl,
163 IN EFI_EVENT_NOTIFY NotifyFunction,
164 IN CONST VOID *NotifyContext, OPTIONAL
165 OUT VOID *Registration OPTIONAL
166 )
167 {
168 EFI_STATUS Status;
169 EFI_EVENT Event;
170 VOID *RegistrationLocal;
171
172 //
173 // Create event
174 //
175 Status = gBS->CreateEvent (
176 EVT_NOTIFY_SIGNAL,
177 NotifyTpl,
178 NotifyFunction,
179 (VOID *) NotifyContext,
180 &Event
181 );
182 ASSERT_EFI_ERROR (Status);
183
184 //
185 // The Registration is not optional to RegisterProtocolNotify().
186 // To make it optional to EfiNamedEventListen(), may need to substitute with a local.
187 //
188 if (Registration != NULL) {
189 RegistrationLocal = Registration;
190 } else {
191 RegistrationLocal = &RegistrationLocal;
192 }
193
194 //
195 // Register for an installation of protocol interface
196 //
197
198 Status = gBS->RegisterProtocolNotify (
199 (EFI_GUID *) Name,
200 Event,
201 RegistrationLocal
202 );
203 ASSERT_EFI_ERROR (Status);
204
205 return EFI_SUCCESS;
206 }
207
208 /**
209 This function signals the named event specified by Name. The named event must
210 have been created with EfiNamedEventListen().
211
212 @param Name Supplies GUID name of the event.
213
214 @retval EFI_SUCCESS A named event was signaled.
215 @retval EFI_OUT_OF_RESOURCES There are not enough resource to signal the named event.
216
217 **/
218 EFI_STATUS
219 EFIAPI
220 EfiNamedEventSignal (
221 IN CONST EFI_GUID *Name
222 )
223 {
224 EFI_STATUS Status;
225 EFI_HANDLE Handle;
226
227 Handle = NULL;
228 Status = gBS->InstallProtocolInterface (
229 &Handle,
230 (EFI_GUID *) Name,
231 EFI_NATIVE_INTERFACE,
232 NULL
233 );
234 ASSERT_EFI_ERROR (Status);
235
236 Status = gBS->UninstallProtocolInterface (
237 Handle,
238 (EFI_GUID *) Name,
239 NULL
240 );
241 ASSERT_EFI_ERROR (Status);
242
243 return EFI_SUCCESS;
244 }
245
246 /**
247 Returns the current TPL.
248
249 This function returns the current TPL. There is no EFI service to directly
250 retrieve the current TPL. Instead, the RaiseTPL() function is used to raise
251 the TPL to TPL_HIGH_LEVEL. This will return the current TPL. The TPL level
252 can then immediately be restored back to the current TPL level with a call
253 to RestoreTPL().
254
255 @return The current TPL.
256
257 **/
258 EFI_TPL
259 EFIAPI
260 EfiGetCurrentTpl (
261 VOID
262 )
263 {
264 EFI_TPL Tpl;
265
266 Tpl = gBS->RaiseTPL (TPL_HIGH_LEVEL);
267 gBS->RestoreTPL (Tpl);
268
269 return Tpl;
270 }
271
272
273 /**
274 This function initializes a basic mutual exclusion lock to the released state
275 and returns the lock. Each lock provides mutual exclusion access at its task
276 priority level. Since there is no preemption or multiprocessor support in EFI,
277 acquiring the lock only consists of raising to the locks TPL.
278
279 @param Lock A pointer to the lock data structure to initialize.
280 @param Priority EFI TPL associated with the lock.
281
282 @return The lock.
283
284 **/
285 EFI_LOCK *
286 EFIAPI
287 EfiInitializeLock (
288 IN OUT EFI_LOCK *Lock,
289 IN EFI_TPL Priority
290 )
291 {
292 ASSERT (Lock != NULL);
293 ASSERT (Priority <= TPL_HIGH_LEVEL);
294
295 Lock->Tpl = Priority;
296 Lock->OwnerTpl = TPL_APPLICATION;
297 Lock->Lock = EfiLockReleased ;
298 return Lock;
299 }
300
301 /**
302 This function raises the system's current task priority level to the task
303 priority level of the mutual exclusion lock. Then, it places the lock in the
304 acquired state.
305
306 @param Lock Point to EFI_LOCK instance
307
308 **/
309 VOID
310 EFIAPI
311 EfiAcquireLock (
312 IN EFI_LOCK *Lock
313 )
314 {
315 ASSERT (Lock != NULL);
316 ASSERT (Lock->Lock == EfiLockReleased);
317
318 Lock->OwnerTpl = gBS->RaiseTPL (Lock->Tpl);
319 Lock->Lock = EfiLockAcquired;
320 }
321
322 /**
323 This function raises the system's current task priority level to the task
324 priority level of the mutual exclusion lock. Then, it attempts to place the
325 lock in the acquired state.
326
327 @param Lock A pointer to the lock to acquire.
328
329 @retval EFI_SUCCESS The lock was acquired.
330 @retval EFI_ACCESS_DENIED The lock could not be acquired because it is already owned.
331
332 **/
333 EFI_STATUS
334 EFIAPI
335 EfiAcquireLockOrFail (
336 IN EFI_LOCK *Lock
337 )
338 {
339
340 ASSERT (Lock != NULL);
341 ASSERT (Lock->Lock != EfiLockUninitialized);
342
343 if (Lock->Lock == EfiLockAcquired) {
344 //
345 // Lock is already owned, so bail out
346 //
347 return EFI_ACCESS_DENIED;
348 }
349
350 Lock->OwnerTpl = gBS->RaiseTPL (Lock->Tpl);
351
352 Lock->Lock = EfiLockAcquired;
353
354 return EFI_SUCCESS;
355 }
356
357 /**
358 This function transitions a mutual exclusion lock from the acquired state to
359 the released state, and restores the system's task priority level to its
360 previous level.
361
362 @param Lock A pointer to the lock to release.
363
364 **/
365 VOID
366 EFIAPI
367 EfiReleaseLock (
368 IN EFI_LOCK *Lock
369 )
370 {
371 EFI_TPL Tpl;
372
373 ASSERT (Lock != NULL);
374 ASSERT (Lock->Lock == EfiLockAcquired);
375
376 Tpl = Lock->OwnerTpl;
377
378 Lock->Lock = EfiLockReleased;
379
380 gBS->RestoreTPL (Tpl);
381 }
382
383 /**
384 Tests whether a controller handle is being managed by a specific driver.
385
386 This function tests whether the driver specified by DriverBindingHandle is
387 currently managing the controller specified by ControllerHandle. This test
388 is performed by evaluating if the the protocol specified by ProtocolGuid is
389 present on ControllerHandle and is was opened by DriverBindingHandle with an
390 attribute of EFI_OPEN_PROTOCOL_BY_DRIVER.
391 If ProtocolGuid is NULL, then ASSERT().
392
393 @param ControllerHandle A handle for a controller to test.
394 @param DriverBindingHandle Specifies the driver binding handle for the
395 driver.
396 @param ProtocolGuid Specifies the protocol that the driver specified
397 by DriverBindingHandle opens in its Start()
398 function.
399
400 @retval EFI_SUCCESS ControllerHandle is managed by the driver
401 specifed by DriverBindingHandle.
402 @retval EFI_UNSUPPORTED ControllerHandle is not managed by the driver
403 specifed by DriverBindingHandle.
404
405 **/
406 EFI_STATUS
407 EFIAPI
408 EfiTestManagedDevice (
409 IN CONST EFI_HANDLE ControllerHandle,
410 IN CONST EFI_HANDLE DriverBindingHandle,
411 IN CONST EFI_GUID *ProtocolGuid
412 )
413 {
414 EFI_STATUS Status;
415 VOID *ManagedInterface;
416
417 ASSERT (ProtocolGuid != NULL);
418
419 Status = gBS->OpenProtocol (
420 ControllerHandle,
421 (EFI_GUID *) ProtocolGuid,
422 &ManagedInterface,
423 DriverBindingHandle,
424 ControllerHandle,
425 EFI_OPEN_PROTOCOL_BY_DRIVER
426 );
427 if (!EFI_ERROR (Status)) {
428 gBS->CloseProtocol (
429 ControllerHandle,
430 (EFI_GUID *) ProtocolGuid,
431 DriverBindingHandle,
432 ControllerHandle
433 );
434 return EFI_UNSUPPORTED;
435 }
436
437 if (Status != EFI_ALREADY_STARTED) {
438 return EFI_UNSUPPORTED;
439 }
440
441 return EFI_SUCCESS;
442 }
443
444 /**
445 Tests whether a child handle is a child device of the controller.
446
447 This function tests whether ChildHandle is one of the children of
448 ControllerHandle. This test is performed by checking to see if the protocol
449 specified by ProtocolGuid is present on ControllerHandle and opened by
450 ChildHandle with an attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
451 If ProtocolGuid is NULL, then ASSERT().
452
453 @param ControllerHandle A handle for a (parent) controller to test.
454 @param ChildHandle A child handle to test.
455 @param ProtocolGuid Supplies the protocol that the child controller
456 opens on its parent controller.
457
458 @retval EFI_SUCCESS ChildHandle is a child of the ControllerHandle.
459 @retval EFI_UNSUPPORTED ChildHandle is not a child of the
460 ControllerHandle.
461
462 **/
463 EFI_STATUS
464 EFIAPI
465 EfiTestChildHandle (
466 IN CONST EFI_HANDLE ControllerHandle,
467 IN CONST EFI_HANDLE ChildHandle,
468 IN CONST EFI_GUID *ProtocolGuid
469 )
470 {
471 EFI_STATUS Status;
472 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfoBuffer;
473 UINTN EntryCount;
474 UINTN Index;
475
476 ASSERT (ProtocolGuid != NULL);
477
478 //
479 // Retrieve the list of agents that are consuming the specific protocol
480 // on ControllerHandle.
481 //
482 Status = gBS->OpenProtocolInformation (
483 ControllerHandle,
484 (EFI_GUID *) ProtocolGuid,
485 &OpenInfoBuffer,
486 &EntryCount
487 );
488 if (EFI_ERROR (Status)) {
489 return EFI_UNSUPPORTED;
490 }
491
492 //
493 // Inspect if ChildHandle is one of the agents.
494 //
495 Status = EFI_UNSUPPORTED;
496 for (Index = 0; Index < EntryCount; Index++) {
497 if ((OpenInfoBuffer[Index].ControllerHandle == ChildHandle) &&
498 (OpenInfoBuffer[Index].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
499 Status = EFI_SUCCESS;
500 break;
501 }
502 }
503
504 FreePool (OpenInfoBuffer);
505 return Status;
506 }
507
508 /**
509 This function looks up a Unicode string in UnicodeStringTable. If Language is
510 a member of SupportedLanguages and a Unicode string is found in UnicodeStringTable
511 that matches the language code specified by Language, then it is returned in
512 UnicodeString.
513
514 @param Language A pointer to the ISO 639-2 language code for the
515 Unicode string to look up and return.
516 @param SupportedLanguages A pointer to the set of ISO 639-2 language codes
517 that the Unicode string table supports. Language
518 must be a member of this set.
519 @param UnicodeStringTable A pointer to the table of Unicode strings.
520 @param UnicodeString A pointer to the Unicode string from UnicodeStringTable
521 that matches the language specified by Language.
522
523 @retval EFI_SUCCESS The Unicode string that matches the language
524 specified by Language was found
525 in the table of Unicoide strings UnicodeStringTable,
526 and it was returned in UnicodeString.
527 @retval EFI_INVALID_PARAMETER Language is NULL.
528 @retval EFI_INVALID_PARAMETER UnicodeString is NULL.
529 @retval EFI_UNSUPPORTED SupportedLanguages is NULL.
530 @retval EFI_UNSUPPORTED UnicodeStringTable is NULL.
531 @retval EFI_UNSUPPORTED The language specified by Language is not a
532 member of SupportedLanguages.
533 @retval EFI_UNSUPPORTED The language specified by Language is not
534 supported by UnicodeStringTable.
535
536 **/
537 EFI_STATUS
538 EFIAPI
539 LookupUnicodeString (
540 IN CONST CHAR8 *Language,
541 IN CONST CHAR8 *SupportedLanguages,
542 IN CONST EFI_UNICODE_STRING_TABLE *UnicodeStringTable,
543 OUT CHAR16 **UnicodeString
544 )
545 {
546 //
547 // Make sure the parameters are valid
548 //
549 if (Language == NULL || UnicodeString == NULL) {
550 return EFI_INVALID_PARAMETER;
551 }
552
553 //
554 // If there are no supported languages, or the Unicode String Table is empty, then the
555 // Unicode String specified by Language is not supported by this Unicode String Table
556 //
557 if (SupportedLanguages == NULL || UnicodeStringTable == NULL) {
558 return EFI_UNSUPPORTED;
559 }
560
561 //
562 // Make sure Language is in the set of Supported Languages
563 //
564 while (*SupportedLanguages != 0) {
565 if (CompareIso639LanguageCode (Language, SupportedLanguages)) {
566
567 //
568 // Search the Unicode String Table for the matching Language specifier
569 //
570 while (UnicodeStringTable->Language != NULL) {
571 if (CompareIso639LanguageCode (Language, UnicodeStringTable->Language)) {
572
573 //
574 // A matching string was found, so return it
575 //
576 *UnicodeString = UnicodeStringTable->UnicodeString;
577 return EFI_SUCCESS;
578 }
579
580 UnicodeStringTable++;
581 }
582
583 return EFI_UNSUPPORTED;
584 }
585
586 SupportedLanguages += 3;
587 }
588
589 return EFI_UNSUPPORTED;
590 }
591
592 /**
593 This function adds a Unicode string to UnicodeStringTable.
594 If Language is a member of SupportedLanguages then UnicodeString is added to
595 UnicodeStringTable. New buffers are allocated for both Language and
596 UnicodeString. The contents of Language and UnicodeString are copied into
597 these new buffers. These buffers are automatically freed when
598 FreeUnicodeStringTable() is called.
599
600 @param Language A pointer to the ISO 639-2 language code for the Unicode
601 string to add.
602 @param SupportedLanguages A pointer to the set of ISO 639-2 language codes
603 that the Unicode string table supports.
604 Language must be a member of this set.
605 @param UnicodeStringTable A pointer to the table of Unicode strings.
606 @param UnicodeString A pointer to the Unicode string to add.
607
608 @retval EFI_SUCCESS The Unicode string that matches the language
609 specified by Language was found in the table of
610 Unicode strings UnicodeStringTable, and it was
611 returned in UnicodeString.
612 @retval EFI_INVALID_PARAMETER Language is NULL.
613 @retval EFI_INVALID_PARAMETER UnicodeString is NULL.
614 @retval EFI_INVALID_PARAMETER UnicodeString is an empty string.
615 @retval EFI_UNSUPPORTED SupportedLanguages is NULL.
616 @retval EFI_ALREADY_STARTED A Unicode string with language Language is
617 already present in UnicodeStringTable.
618 @retval EFI_OUT_OF_RESOURCES There is not enough memory to add another
619 Unicode string to UnicodeStringTable.
620 @retval EFI_UNSUPPORTED The language specified by Language is not a
621 member of SupportedLanguages.
622
623 **/
624 EFI_STATUS
625 EFIAPI
626 AddUnicodeString (
627 IN CONST CHAR8 *Language,
628 IN CONST CHAR8 *SupportedLanguages,
629 IN EFI_UNICODE_STRING_TABLE **UnicodeStringTable,
630 IN CONST CHAR16 *UnicodeString
631 )
632 {
633 UINTN NumberOfEntries;
634 EFI_UNICODE_STRING_TABLE *OldUnicodeStringTable;
635 EFI_UNICODE_STRING_TABLE *NewUnicodeStringTable;
636 UINTN UnicodeStringLength;
637
638 //
639 // Make sure the parameter are valid
640 //
641 if (Language == NULL || UnicodeString == NULL || UnicodeStringTable == NULL) {
642 return EFI_INVALID_PARAMETER;
643 }
644
645 //
646 // If there are no supported languages, then a Unicode String can not be added
647 //
648 if (SupportedLanguages == NULL) {
649 return EFI_UNSUPPORTED;
650 }
651
652 //
653 // If the Unicode String is empty, then a Unicode String can not be added
654 //
655 if (UnicodeString[0] == 0) {
656 return EFI_INVALID_PARAMETER;
657 }
658
659 //
660 // Make sure Language is a member of SupportedLanguages
661 //
662 while (*SupportedLanguages != 0) {
663 if (CompareIso639LanguageCode (Language, SupportedLanguages)) {
664
665 //
666 // Determine the size of the Unicode String Table by looking for a NULL Language entry
667 //
668 NumberOfEntries = 0;
669 if (*UnicodeStringTable != NULL) {
670 OldUnicodeStringTable = *UnicodeStringTable;
671 while (OldUnicodeStringTable->Language != NULL) {
672 if (CompareIso639LanguageCode (Language, OldUnicodeStringTable->Language)) {
673 return EFI_ALREADY_STARTED;
674 }
675
676 OldUnicodeStringTable++;
677 NumberOfEntries++;
678 }
679 }
680
681 //
682 // Allocate space for a new Unicode String Table. It must hold the current number of
683 // entries, plus 1 entry for the new Unicode String, plus 1 entry for the end of table
684 // marker
685 //
686 NewUnicodeStringTable = AllocatePool ((NumberOfEntries + 2) * sizeof (EFI_UNICODE_STRING_TABLE));
687 if (NewUnicodeStringTable == NULL) {
688 return EFI_OUT_OF_RESOURCES;
689 }
690
691 //
692 // If the current Unicode String Table contains any entries, then copy them to the
693 // newly allocated Unicode String Table.
694 //
695 if (*UnicodeStringTable != NULL) {
696 CopyMem (
697 NewUnicodeStringTable,
698 *UnicodeStringTable,
699 NumberOfEntries * sizeof (EFI_UNICODE_STRING_TABLE)
700 );
701 }
702
703 //
704 // Allocate space for a copy of the Language specifier
705 //
706 NewUnicodeStringTable[NumberOfEntries].Language = AllocateCopyPool (3, Language);
707 if (NewUnicodeStringTable[NumberOfEntries].Language == NULL) {
708 gBS->FreePool (NewUnicodeStringTable);
709 return EFI_OUT_OF_RESOURCES;
710 }
711
712 //
713 // Compute the length of the Unicode String
714 //
715 for (UnicodeStringLength = 0; UnicodeString[UnicodeStringLength] != 0; UnicodeStringLength++)
716 ;
717
718 //
719 // Allocate space for a copy of the Unicode String
720 //
721 NewUnicodeStringTable[NumberOfEntries].UnicodeString = AllocateCopyPool (
722 (UnicodeStringLength + 1) * sizeof (CHAR16),
723 UnicodeString
724 );
725 if (NewUnicodeStringTable[NumberOfEntries].UnicodeString == NULL) {
726 gBS->FreePool (NewUnicodeStringTable[NumberOfEntries].Language);
727 gBS->FreePool (NewUnicodeStringTable);
728 return EFI_OUT_OF_RESOURCES;
729 }
730
731 //
732 // Mark the end of the Unicode String Table
733 //
734 NewUnicodeStringTable[NumberOfEntries + 1].Language = NULL;
735 NewUnicodeStringTable[NumberOfEntries + 1].UnicodeString = NULL;
736
737 //
738 // Free the old Unicode String Table
739 //
740 if (*UnicodeStringTable != NULL) {
741 gBS->FreePool (*UnicodeStringTable);
742 }
743
744 //
745 // Point UnicodeStringTable at the newly allocated Unicode String Table
746 //
747 *UnicodeStringTable = NewUnicodeStringTable;
748
749 return EFI_SUCCESS;
750 }
751
752 SupportedLanguages += 3;
753 }
754
755 return EFI_UNSUPPORTED;
756 }
757
758 /**
759 This function frees the table of Unicode strings in UnicodeStringTable.
760 If UnicodeStringTable is NULL, then EFI_SUCCESS is returned.
761 Otherwise, each language code, and each Unicode string in the Unicode string
762 table are freed, and EFI_SUCCESS is returned.
763
764 @param UnicodeStringTable A pointer to the table of Unicode strings.
765
766 @retval EFI_SUCCESS The Unicode string table was freed.
767
768 **/
769 EFI_STATUS
770 EFIAPI
771 FreeUnicodeStringTable (
772 IN EFI_UNICODE_STRING_TABLE *UnicodeStringTable
773 )
774 {
775 UINTN Index;
776
777 //
778 // If the Unicode String Table is NULL, then it is already freed
779 //
780 if (UnicodeStringTable == NULL) {
781 return EFI_SUCCESS;
782 }
783
784 //
785 // Loop through the Unicode String Table until we reach the end of table marker
786 //
787 for (Index = 0; UnicodeStringTable[Index].Language != NULL; Index++) {
788
789 //
790 // Free the Language string from the Unicode String Table
791 //
792 gBS->FreePool (UnicodeStringTable[Index].Language);
793
794 //
795 // Free the Unicode String from the Unicode String Table
796 //
797 if (UnicodeStringTable[Index].UnicodeString != NULL) {
798 gBS->FreePool (UnicodeStringTable[Index].UnicodeString);
799 }
800 }
801
802 //
803 // Free the Unicode String Table itself
804 //
805 gBS->FreePool (UnicodeStringTable);
806
807 return EFI_SUCCESS;
808 }
809