1) Added BIT0, BIT1, …, BIT63 to the Base Defines
[mirror_edk2.git] / MdePkg / Library / UefiLib / UefiLib.c
1 /** @file
2 Mde UEFI library functions.
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 Module Name: UefiLib.c
14
15 **/
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 EFI_EVENT_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 EFI_EVENT_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 @param VOID
256
257 @retvale EFI_TPL The current TPL.
258
259 **/
260 EFI_TPL
261 EFIAPI
262 EfiGetCurrentTpl (
263 VOID
264 )
265 {
266 EFI_TPL Tpl;
267
268 Tpl = gBS->RaiseTPL (EFI_TPL_HIGH_LEVEL);
269 gBS->RestoreTPL (Tpl);
270
271 return Tpl;
272 }
273
274
275 /**
276 This function initializes a basic mutual exclusion lock to the released state
277 and returns the lock. Each lock provides mutual exclusion access at its task
278 priority level. Since there is no preemption or multiprocessor support in EFI,
279 acquiring the lock only consists of raising to the locks TPL.
280
281 @param Lock A pointer to the lock data structure to initialize.
282 @param Priority EFI TPL associated with the lock.
283
284 @return The lock.
285
286 **/
287 EFI_LOCK *
288 EFIAPI
289 EfiInitializeLock (
290 IN OUT EFI_LOCK *Lock,
291 IN EFI_TPL Priority
292 )
293 {
294 ASSERT (Lock != NULL);
295 ASSERT (Priority <= EFI_TPL_HIGH_LEVEL);
296
297 Lock->Tpl = Priority;
298 Lock->OwnerTpl = EFI_TPL_APPLICATION;
299 Lock->Lock = EfiLockReleased ;
300 return Lock;
301 }
302
303 /**
304 This function raises the system's current task priority level to the task
305 priority level of the mutual exclusion lock. Then, it places the lock in the
306 acquired state.
307
308 @param Priority The task priority level of the lock.
309
310 **/
311 VOID
312 EFIAPI
313 EfiAcquireLock (
314 IN EFI_LOCK *Lock
315 )
316 {
317 ASSERT (Lock != NULL);
318 ASSERT (Lock->Lock == EfiLockReleased);
319
320 Lock->OwnerTpl = gBS->RaiseTPL (Lock->Tpl);
321 Lock->Lock = EfiLockAcquired;
322 }
323
324 /**
325 This function raises the system's current task priority level to the task
326 priority level of the mutual exclusion lock. Then, it attempts to place the
327 lock in the acquired state.
328
329 @param Lock A pointer to the lock to acquire.
330
331 @retval EFI_SUCCESS The lock was acquired.
332 @retval EFI_ACCESS_DENIED The lock could not be acquired because it is already owned.
333
334 **/
335 EFI_STATUS
336 EFIAPI
337 EfiAcquireLockOrFail (
338 IN EFI_LOCK *Lock
339 )
340 {
341
342 ASSERT (Lock != NULL);
343 ASSERT (Lock->Lock != EfiLockUninitialized);
344
345 if (Lock->Lock == EfiLockAcquired) {
346 //
347 // Lock is already owned, so bail out
348 //
349 return EFI_ACCESS_DENIED;
350 }
351
352 Lock->OwnerTpl = gBS->RaiseTPL (Lock->Tpl);
353
354 Lock->Lock = EfiLockAcquired;
355
356 return EFI_SUCCESS;
357 }
358
359 /**
360 This function transitions a mutual exclusion lock from the acquired state to
361 the released state, and restores the system's task priority level to its
362 previous level.
363
364 @param Lock A pointer to the lock to release.
365
366 **/
367 VOID
368 EFIAPI
369 EfiReleaseLock (
370 IN EFI_LOCK *Lock
371 )
372 {
373 EFI_TPL Tpl;
374
375 ASSERT (Lock != NULL);
376 ASSERT (Lock->Lock == EfiLockAcquired);
377
378 Tpl = Lock->OwnerTpl;
379
380 Lock->Lock = EfiLockReleased;
381
382 gBS->RestoreTPL (Tpl);
383 }
384
385 /**
386 Tests whether a controller is managed by a specific driver.
387
388 This function tests whether a specific driver manages ControllerHandle by
389 opening on DriverBindingHandle a protocol specified by ProtocolGuid with
390 attribute EFI_OPEN_PROTOCOL_BY_DRIVER. This library function is used to
391 implement the Component Name Protocol for EFI Drivers.
392 If ProtocolGuid is NULL, then ASSERT().
393
394 @param ControllerHandle A handle for a controller to test.
395 @param DriverBindingHandle Specifies the driver binding handle for the
396 driver.
397 @param ProtocolGuid Supplies GUID for the protocol opened by the
398 driver on the controller.
399
400 @retval EFI_SUCCESS ControllerHandle is managed by the specific
401 driver.
402 @retval EFI_UNSUPPORTED ControllerHandle is not managed by the specific
403 driver.
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 children device of the controller.
446
447 This function tests whether ChildHandle is one of the children of
448 ControllerHandle which are consuming a protocol specified by ProtocolGuid
449 with the attribute bit EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER set. This
450 library function is used to implement the Component Name Protocol for EFI
451 Drivers.
452 If ProtocolGuid is NULL, then ASSERT().
453
454 @param ControllerHandle A handle for a (parent) controller to test.
455 @param ChildHandle A child handle to test.
456 @param ConsumsedGuid Supplies GUID for the protocol consumed by
457 children from controller.
458
459 @retval EFI_SUCCESS ChildHandle is a child of the ControllerHandle.
460 @retval EFI_UNSUPPORTED ChildHandle is not a child of the
461 ControllerHandle.
462
463 **/
464 EFI_STATUS
465 EFIAPI
466 EfiTestChildHandle (
467 IN CONST EFI_HANDLE ControllerHandle,
468 IN CONST EFI_HANDLE ChildHandle,
469 IN CONST EFI_GUID *ProtocolGuid
470 )
471 {
472 EFI_STATUS Status;
473 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfoBuffer;
474 UINTN EntryCount;
475 UINTN Index;
476
477 ASSERT (ProtocolGuid != NULL);
478
479 //
480 // Retrieve the list of agents that are consuming the specific protocol
481 // on ControllerHandle.
482 //
483 Status = gBS->OpenProtocolInformation (
484 ControllerHandle,
485 (EFI_GUID *) ProtocolGuid,
486 &OpenInfoBuffer,
487 &EntryCount
488 );
489 if (EFI_ERROR (Status)) {
490 return EFI_UNSUPPORTED;
491 }
492
493 //
494 // Inspect if ChildHandle is one of the agents.
495 //
496 Status = EFI_UNSUPPORTED;
497 for (Index = 0; Index < EntryCount; Index++) {
498 if ((OpenInfoBuffer[Index].ControllerHandle == ChildHandle) &&
499 (OpenInfoBuffer[Index].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
500 Status = EFI_SUCCESS;
501 break;
502 }
503 }
504
505 FreePool (OpenInfoBuffer);
506 return Status;
507 }
508
509 /**
510 This function looks up a Unicode string in UnicodeStringTable. If Language is
511 a member of SupportedLanguages and a Unicode string is found in UnicodeStringTable
512 that matches the language code specified by Language, then it is returned in
513 UnicodeString.
514
515 @param Language A pointer to the ISO 639-2 language code for the
516 Unicode string to look up and return.
517 @param SupportedLanguages A pointer to the set of ISO 639-2 language codes
518 that the Unicode string table supports. Language
519 must be a member of this set.
520 @param UnicodeStringTable A pointer to the table of Unicode strings.
521 @param UnicodeString A pointer to the Unicode string from UnicodeStringTable
522 that matches the language specified by Language.
523
524 @retval EFI_SUCCESS The Unicode string that matches the language
525 specified by Language was found
526 in the table of Unicoide strings UnicodeStringTable,
527 and it was returned in UnicodeString.
528 @retval EFI_INVALID_PARAMETER Language is NULL.
529 @retval EFI_INVALID_PARAMETER UnicodeString is NULL.
530 @retval EFI_UNSUPPORTED SupportedLanguages is NULL.
531 @retval EFI_UNSUPPORTED UnicodeStringTable is NULL.
532 @retval EFI_UNSUPPORTED The language specified by Language is not a
533 member of SupportedLanguages.
534 @retval EFI_UNSUPPORTED The language specified by Language is not
535 supported by UnicodeStringTable.
536
537 **/
538 EFI_STATUS
539 EFIAPI
540 LookupUnicodeString (
541 IN CONST CHAR8 *Language,
542 IN CONST CHAR8 *SupportedLanguages,
543 IN CONST EFI_UNICODE_STRING_TABLE *UnicodeStringTable,
544 OUT CHAR16 **UnicodeString
545 )
546 {
547 //
548 // Make sure the parameters are valid
549 //
550 if (Language == NULL || UnicodeString == NULL) {
551 return EFI_INVALID_PARAMETER;
552 }
553
554 //
555 // If there are no supported languages, or the Unicode String Table is empty, then the
556 // Unicode String specified by Language is not supported by this Unicode String Table
557 //
558 if (SupportedLanguages == NULL || UnicodeStringTable == NULL) {
559 return EFI_UNSUPPORTED;
560 }
561
562 //
563 // Make sure Language is in the set of Supported Languages
564 //
565 while (*SupportedLanguages != 0) {
566 if (CompareIso639LanguageCode (Language, SupportedLanguages)) {
567
568 //
569 // Search the Unicode String Table for the matching Language specifier
570 //
571 while (UnicodeStringTable->Language != NULL) {
572 if (CompareIso639LanguageCode (Language, UnicodeStringTable->Language)) {
573
574 //
575 // A matching string was found, so return it
576 //
577 *UnicodeString = UnicodeStringTable->UnicodeString;
578 return EFI_SUCCESS;
579 }
580
581 UnicodeStringTable++;
582 }
583
584 return EFI_UNSUPPORTED;
585 }
586
587 SupportedLanguages += 3;
588 }
589
590 return EFI_UNSUPPORTED;
591 }
592
593 /**
594 This function adds a Unicode string to UnicodeStringTable.
595 If Language is a member of SupportedLanguages then UnicodeString is added to
596 UnicodeStringTable. New buffers are allocated for both Language and
597 UnicodeString. The contents of Language and UnicodeString are copied into
598 these new buffers. These buffers are automatically freed when
599 FreeUnicodeStringTable() is called.
600
601 @param Language A pointer to the ISO 639-2 language code for the Unicode
602 string to add.
603 @param SupportedLanguages A pointer to the set of ISO 639-2 language codes
604 that the Unicode string table supports.
605 Language must be a member of this set.
606 @param UnicodeStringTable A pointer to the table of Unicode strings.
607 @param UnicodeString A pointer to the Unicode string to add.
608
609 @retval EFI_SUCCESS The Unicode string that matches the language
610 specified by Language was found in the table of
611 Unicode strings UnicodeStringTable, and it was
612 returned in UnicodeString.
613 @retval EFI_INVALID_PARAMETER Language is NULL.
614 @retval EFI_INVALID_PARAMETER UnicodeString is NULL.
615 @retval EFI_INVALID_PARAMETER UnicodeString is an empty string.
616 @retval EFI_UNSUPPORTED SupportedLanguages is NULL.
617 @retval EFI_ALREADY_STARTED A Unicode string with language Language is
618 already present in UnicodeStringTable.
619 @retval EFI_OUT_OF_RESOURCES There is not enough memory to add another
620 Unicode string to UnicodeStringTable.
621 @retval EFI_UNSUPPORTED The language specified by Language is not a
622 member of SupportedLanguages.
623
624 **/
625 EFI_STATUS
626 EFIAPI
627 AddUnicodeString (
628 IN CONST CHAR8 *Language,
629 IN CONST CHAR8 *SupportedLanguages,
630 IN EFI_UNICODE_STRING_TABLE **UnicodeStringTable,
631 IN CONST CHAR16 *UnicodeString
632 )
633 {
634 UINTN NumberOfEntries;
635 EFI_UNICODE_STRING_TABLE *OldUnicodeStringTable;
636 EFI_UNICODE_STRING_TABLE *NewUnicodeStringTable;
637 UINTN UnicodeStringLength;
638
639 //
640 // Make sure the parameter are valid
641 //
642 if (Language == NULL || UnicodeString == NULL || UnicodeStringTable == NULL) {
643 return EFI_INVALID_PARAMETER;
644 }
645
646 //
647 // If there are no supported languages, then a Unicode String can not be added
648 //
649 if (SupportedLanguages == NULL) {
650 return EFI_UNSUPPORTED;
651 }
652
653 //
654 // If the Unicode String is empty, then a Unicode String can not be added
655 //
656 if (UnicodeString[0] == 0) {
657 return EFI_INVALID_PARAMETER;
658 }
659
660 //
661 // Make sure Language is a member of SupportedLanguages
662 //
663 while (*SupportedLanguages != 0) {
664 if (CompareIso639LanguageCode (Language, SupportedLanguages)) {
665
666 //
667 // Determine the size of the Unicode String Table by looking for a NULL Language entry
668 //
669 NumberOfEntries = 0;
670 if (*UnicodeStringTable != NULL) {
671 OldUnicodeStringTable = *UnicodeStringTable;
672 while (OldUnicodeStringTable->Language != NULL) {
673 if (CompareIso639LanguageCode (Language, OldUnicodeStringTable->Language)) {
674 return EFI_ALREADY_STARTED;
675 }
676
677 OldUnicodeStringTable++;
678 NumberOfEntries++;
679 }
680 }
681
682 //
683 // Allocate space for a new Unicode String Table. It must hold the current number of
684 // entries, plus 1 entry for the new Unicode String, plus 1 entry for the end of table
685 // marker
686 //
687 NewUnicodeStringTable = AllocatePool ((NumberOfEntries + 2) * sizeof (EFI_UNICODE_STRING_TABLE));
688 if (NewUnicodeStringTable == NULL) {
689 return EFI_OUT_OF_RESOURCES;
690 }
691
692 //
693 // If the current Unicode String Table contains any entries, then copy them to the
694 // newly allocated Unicode String Table.
695 //
696 if (*UnicodeStringTable != NULL) {
697 CopyMem (
698 NewUnicodeStringTable,
699 *UnicodeStringTable,
700 NumberOfEntries * sizeof (EFI_UNICODE_STRING_TABLE)
701 );
702 }
703
704 //
705 // Allocate space for a copy of the Language specifier
706 //
707 NewUnicodeStringTable[NumberOfEntries].Language = AllocateCopyPool (3, Language);
708 if (NewUnicodeStringTable[NumberOfEntries].Language == NULL) {
709 gBS->FreePool (NewUnicodeStringTable);
710 return EFI_OUT_OF_RESOURCES;
711 }
712
713 //
714 // Compute the length of the Unicode String
715 //
716 for (UnicodeStringLength = 0; UnicodeString[UnicodeStringLength] != 0; UnicodeStringLength++)
717 ;
718
719 //
720 // Allocate space for a copy of the Unicode String
721 //
722 NewUnicodeStringTable[NumberOfEntries].UnicodeString = AllocateCopyPool (
723 (UnicodeStringLength + 1) * sizeof (CHAR16),
724 UnicodeString
725 );
726 if (NewUnicodeStringTable[NumberOfEntries].UnicodeString == NULL) {
727 gBS->FreePool (NewUnicodeStringTable[NumberOfEntries].Language);
728 gBS->FreePool (NewUnicodeStringTable);
729 return EFI_OUT_OF_RESOURCES;
730 }
731
732 //
733 // Mark the end of the Unicode String Table
734 //
735 NewUnicodeStringTable[NumberOfEntries + 1].Language = NULL;
736 NewUnicodeStringTable[NumberOfEntries + 1].UnicodeString = NULL;
737
738 //
739 // Free the old Unicode String Table
740 //
741 if (*UnicodeStringTable != NULL) {
742 gBS->FreePool (*UnicodeStringTable);
743 }
744
745 //
746 // Point UnicodeStringTable at the newly allocated Unicode String Table
747 //
748 *UnicodeStringTable = NewUnicodeStringTable;
749
750 return EFI_SUCCESS;
751 }
752
753 SupportedLanguages += 3;
754 }
755
756 return EFI_UNSUPPORTED;
757 }
758
759 /**
760 This function frees the table of Unicode strings in UnicodeStringTable.
761 If UnicodeStringTable is NULL, then EFI_SUCCESS is returned.
762 Otherwise, each language code, and each Unicode string in the Unicode string
763 table are freed, and EFI_SUCCESS is returned.
764
765 @param UnicodeStringTable A pointer to the table of Unicode strings.
766
767 @retval EFI_SUCCESS The Unicode string table was freed.
768
769 **/
770 EFI_STATUS
771 EFIAPI
772 FreeUnicodeStringTable (
773 IN EFI_UNICODE_STRING_TABLE *UnicodeStringTable
774 )
775 {
776 UINTN Index;
777
778 //
779 // If the Unicode String Table is NULL, then it is already freed
780 //
781 if (UnicodeStringTable == NULL) {
782 return EFI_SUCCESS;
783 }
784
785 //
786 // Loop through the Unicode String Table until we reach the end of table marker
787 //
788 for (Index = 0; UnicodeStringTable[Index].Language != NULL; Index++) {
789
790 //
791 // Free the Language string from the Unicode String Table
792 //
793 gBS->FreePool (UnicodeStringTable[Index].Language);
794
795 //
796 // Free the Unicode String from the Unicode String Table
797 //
798 if (UnicodeStringTable[Index].UnicodeString != NULL) {
799 gBS->FreePool (UnicodeStringTable[Index].UnicodeString);
800 }
801 }
802
803 //
804 // Free the Unicode String Table itself
805 //
806 gBS->FreePool (UnicodeStringTable);
807
808 return EFI_SUCCESS;
809 }
810