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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
|
// SPDX-License-Identifier: GPL-2.0+
/*
* efi_selftest_hii
*
* Copyright (c) 2018 AKASHI Takahiro, Linaro Limited
*
* Test HII database protocols
*/
#include <efi_selftest.h>
#include "efi_selftest_hii_data.c"
#define PRINT_TESTNAME efi_st_printf("%s:\n", __func__)
static struct efi_boot_services *boottime;
static const efi_guid_t hii_database_protocol_guid =
EFI_HII_DATABASE_PROTOCOL_GUID;
static const efi_guid_t hii_string_protocol_guid =
EFI_HII_STRING_PROTOCOL_GUID;
static struct efi_hii_database_protocol *hii_database_protocol;
static struct efi_hii_string_protocol *hii_string_protocol;
/*
* Setup unit test.
*
* @handle: handle of the loaded image
* @systable: system table
*
* Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
{
efi_status_t ret;
boottime = systable->boottime;
/* HII database protocol */
ret = boottime->locate_protocol(&hii_database_protocol_guid, NULL,
(void **)&hii_database_protocol);
if (ret != EFI_SUCCESS) {
hii_database_protocol = NULL;
efi_st_error("HII database protocol is not available.\n");
return EFI_ST_FAILURE;
}
/* HII string protocol */
ret = boottime->locate_protocol(&hii_string_protocol_guid, NULL,
(void **)&hii_string_protocol);
if (ret != EFI_SUCCESS) {
hii_string_protocol = NULL;
efi_st_error("HII string protocol is not available.\n");
return EFI_ST_FAILURE;
}
return EFI_ST_SUCCESS;
}
/*
* HII database protocol tests
*/
/**
* test_hii_database_new_package_list() - test creation and removal of
* package list
*
* This test adds a new package list and then tries to remove it using
* the provided handle.
*
* @Return: status code
*/
static int test_hii_database_new_package_list(void)
{
efi_hii_handle_t handle;
efi_status_t ret;
PRINT_TESTNAME;
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist1,
NULL, &handle);
if (ret != EFI_SUCCESS || !handle) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
ret = hii_database_protocol->remove_package_list(hii_database_protocol,
handle);
if (ret != EFI_SUCCESS) {
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
return EFI_ST_SUCCESS;
}
/**
* test_hii_database_update_package_list() - test update of package list
*
* This test adds a new package list and then tries to update it using
* another package list.
*
* @Return: status code
*/
static int test_hii_database_update_package_list(void)
{
efi_hii_handle_t handle = NULL;
efi_status_t ret;
int result = EFI_ST_FAILURE;
PRINT_TESTNAME;
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist1,
NULL, &handle);
if (ret != EFI_SUCCESS || !handle) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
ret = hii_database_protocol->update_package_list(hii_database_protocol,
handle,
(struct efi_hii_package_list_header *)packagelist2);
if (ret != EFI_SUCCESS || !handle) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
goto out;
}
result = EFI_ST_SUCCESS;
out:
if (handle) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle);
if (ret != EFI_SUCCESS) {
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
}
return result;
}
/**
* test_hii_database_list_package_lists() - test listing of package lists
*
* This test adds two package lists and then tries to enumerate them
* against different package types. We will get an array of handles.
*
* @Return: status code
*/
static int test_hii_database_list_package_lists(void)
{
efi_hii_handle_t handle1 = NULL, handle2 = NULL, *handles;
efi_uintn_t handles_size;
efi_status_t ret;
int result = EFI_ST_FAILURE;
PRINT_TESTNAME;
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist1,
NULL, &handle1);
if (ret != EFI_SUCCESS || !handle1) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
goto out;
}
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist2,
NULL, &handle2);
if (ret != EFI_SUCCESS || !handle2) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
goto out;
}
/* TYPE_ALL */
handles = NULL;
handles_size = 0;
ret = hii_database_protocol->list_package_lists(hii_database_protocol,
EFI_HII_PACKAGE_TYPE_ALL, NULL,
&handles_size, handles);
if (ret != EFI_BUFFER_TOO_SMALL) {
efi_st_error("list_package_lists returned %u\n",
(unsigned int)ret);
goto out;
}
ret = boottime->allocate_pool(EFI_LOADER_DATA, handles_size,
(void **)&handles);
if (ret != EFI_SUCCESS) {
efi_st_error("AllocatePool failed\n");
goto out;
}
ret = hii_database_protocol->list_package_lists(hii_database_protocol,
EFI_HII_PACKAGE_TYPE_ALL, NULL,
&handles_size, handles);
if (ret != EFI_SUCCESS) {
efi_st_error("list_package_lists returned %u\n",
(unsigned int)ret);
goto out;
}
ret = boottime->free_pool(handles);
if (ret != EFI_SUCCESS) {
efi_st_error("FreePool failed\n");
goto out;
}
/* STRINGS */
handles = NULL;
handles_size = 0;
ret = hii_database_protocol->list_package_lists(hii_database_protocol,
EFI_HII_PACKAGE_STRINGS, NULL,
&handles_size, handles);
if (ret != EFI_BUFFER_TOO_SMALL) {
efi_st_error("list_package_lists returned %u\n",
(unsigned int)ret);
ret = EFI_ST_FAILURE;
goto out;
}
ret = boottime->allocate_pool(EFI_LOADER_DATA, handles_size,
(void **)&handles);
if (ret != EFI_SUCCESS) {
efi_st_error("AllocatePool failed\n");
ret = EFI_ST_FAILURE;
goto out;
}
ret = hii_database_protocol->list_package_lists(hii_database_protocol,
EFI_HII_PACKAGE_STRINGS, NULL,
&handles_size, handles);
if (ret != EFI_SUCCESS) {
efi_st_error("list_package_lists returned %u\n",
(unsigned int)ret);
ret = EFI_ST_FAILURE;
goto out;
}
ret = boottime->free_pool(handles);
if (ret != EFI_SUCCESS) {
efi_st_error("FreePool failed\n");
goto out;
}
/* GUID */
handles = NULL;
handles_size = 0;
ret = hii_database_protocol->list_package_lists(hii_database_protocol,
EFI_HII_PACKAGE_TYPE_GUID, &package_guid,
&handles_size, handles);
if (ret != EFI_BUFFER_TOO_SMALL) {
efi_st_error("list_package_lists returned %u\n",
(unsigned int)ret);
ret = EFI_ST_FAILURE;
goto out;
}
ret = boottime->allocate_pool(EFI_LOADER_DATA, handles_size,
(void **)&handles);
if (ret != EFI_SUCCESS) {
efi_st_error("AllocatePool failed\n");
ret = EFI_ST_FAILURE;
goto out;
}
ret = hii_database_protocol->list_package_lists(hii_database_protocol,
EFI_HII_PACKAGE_TYPE_GUID, &package_guid,
&handles_size, handles);
if (ret != EFI_SUCCESS) {
efi_st_error("list_package_lists returned %u\n",
(unsigned int)ret);
ret = EFI_ST_FAILURE;
goto out;
}
ret = boottime->free_pool(handles);
if (ret != EFI_SUCCESS) {
efi_st_error("FreePool failed\n");
ret = EFI_ST_FAILURE;
goto out;
}
/* KEYBOARD_LAYOUT */
handles = NULL;
handles_size = 0;
ret = hii_database_protocol->list_package_lists(hii_database_protocol,
EFI_HII_PACKAGE_KEYBOARD_LAYOUT, NULL,
&handles_size, handles);
if (ret != EFI_BUFFER_TOO_SMALL) {
efi_st_error("list_package_lists returned %u\n",
(unsigned int)ret);
ret = EFI_ST_FAILURE;
goto out;
}
ret = boottime->allocate_pool(EFI_LOADER_DATA, handles_size,
(void **)&handles);
if (ret != EFI_SUCCESS) {
efi_st_error("AllocatePool failed\n");
ret = EFI_ST_FAILURE;
goto out;
}
ret = hii_database_protocol->list_package_lists(hii_database_protocol,
EFI_HII_PACKAGE_KEYBOARD_LAYOUT, NULL,
&handles_size, handles);
if (ret != EFI_SUCCESS) {
efi_st_error("list_package_lists returned %u\n",
(unsigned int)ret);
ret = EFI_ST_FAILURE;
goto out;
}
ret = boottime->free_pool(handles);
if (ret != EFI_SUCCESS) {
efi_st_error("FreePool failed\n");
ret = EFI_ST_FAILURE;
goto out;
}
result = EFI_ST_SUCCESS;
out:
if (handle1) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle1);
if (ret != EFI_SUCCESS)
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
}
if (handle2) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle2);
if (ret != EFI_SUCCESS)
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
}
return result;
}
/**
* test_hii_database_export_package_lists() - test export of package lists
*
* @Return: status code
*/
static int test_hii_database_export_package_lists(void)
{
PRINT_TESTNAME;
/* export_package_lists() not implemented yet */
return EFI_ST_SUCCESS;
}
/**
* test_hii_database_register_package_notify() - test registration of
* notification function
*
* @Return: status code
*/
static int test_hii_database_register_package_notify(void)
{
PRINT_TESTNAME;
/* register_package_notify() not implemented yet */
return EFI_ST_SUCCESS;
}
/**
* test_hii_database_unregister_package_notify() - test removal of
* notification function
*
* @Return: status code
*/
static int test_hii_database_unregister_package_notify(void)
{
PRINT_TESTNAME;
/* unregsiter_package_notify() not implemented yet */
return EFI_ST_SUCCESS;
}
/**
* test_hii_database_find_keyboard_layouts() - test listing of
* all the keyboard layouts in the system
*
* This test adds two package lists, each of which has two keyboard layouts
* and then tries to enumerate them. We will get an array of handles.
*
* @Return: status code
*/
static int test_hii_database_find_keyboard_layouts(void)
{
efi_hii_handle_t handle1 = NULL, handle2 = NULL;
efi_guid_t *guids;
u16 guids_size;
efi_status_t ret;
int result = EFI_ST_FAILURE;
PRINT_TESTNAME;
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist1,
NULL, &handle1);
if (ret != EFI_SUCCESS || !handle1) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
goto out;
}
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist2,
NULL, &handle2);
if (ret != EFI_SUCCESS || !handle2) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
goto out;
}
guids = NULL;
guids_size = 0;
ret = hii_database_protocol->find_keyboard_layouts(
hii_database_protocol, &guids_size, guids);
if (ret != EFI_BUFFER_TOO_SMALL) {
efi_st_error("find_keyboard_layouts returned %u\n",
(unsigned int)ret);
goto out;
}
ret = boottime->allocate_pool(EFI_LOADER_DATA, guids_size,
(void **)&guids);
if (ret != EFI_SUCCESS) {
efi_st_error("AllocatePool failed\n");
goto out;
}
ret = hii_database_protocol->find_keyboard_layouts(
hii_database_protocol, &guids_size, guids);
if (ret != EFI_SUCCESS) {
efi_st_error("find_keyboard_layouts returned %u\n",
(unsigned int)ret);
goto out;
}
ret = boottime->free_pool(guids);
if (ret != EFI_SUCCESS) {
efi_st_error("FreePool failed\n");
goto out;
}
result = EFI_ST_SUCCESS;
out:
if (handle1) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle1);
if (ret != EFI_SUCCESS)
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
}
if (handle2) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle2);
if (ret != EFI_SUCCESS)
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
}
return result;
}
/**
* test_hii_database_get_keyboard_layout() - test retrieval of keyboard layout
*
* This test adds two package lists, each of which has two keyboard layouts
* and then tries to get a handle to keyboard layout with a specific guid
* and the current one.
*
* @Return: status code
*/
static int test_hii_database_get_keyboard_layout(void)
{
efi_hii_handle_t handle1 = NULL, handle2 = NULL;
struct efi_hii_keyboard_layout *kb_layout;
u16 kb_layout_size;
efi_status_t ret;
int result = EFI_ST_FAILURE;
PRINT_TESTNAME;
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist1,
NULL, &handle1);
if (ret != EFI_SUCCESS || !handle1) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
goto out;
}
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist2,
NULL, &handle2);
if (ret != EFI_SUCCESS || !handle2) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
goto out;
}
/* specific keyboard_layout(guid11) */
kb_layout = NULL;
kb_layout_size = 0;
ret = hii_database_protocol->get_keyboard_layout(hii_database_protocol,
&kb_layout_guid11, &kb_layout_size, kb_layout);
if (ret != EFI_BUFFER_TOO_SMALL) {
efi_st_error("get_keyboard_layout returned %u\n",
(unsigned int)ret);
goto out;
}
ret = boottime->allocate_pool(EFI_LOADER_DATA, kb_layout_size,
(void **)&kb_layout);
if (ret != EFI_SUCCESS) {
efi_st_error("AllocatePool failed\n");
goto out;
}
ret = hii_database_protocol->get_keyboard_layout(hii_database_protocol,
&kb_layout_guid11, &kb_layout_size, kb_layout);
if (ret != EFI_SUCCESS) {
efi_st_error("get_keyboard_layout returned %u\n",
(unsigned int)ret);
goto out;
}
ret = boottime->free_pool(kb_layout);
if (ret != EFI_SUCCESS) {
efi_st_error("FreePool failed\n");
goto out;
}
/* current */
kb_layout = NULL;
kb_layout_size = 0;
ret = hii_database_protocol->get_keyboard_layout(hii_database_protocol,
NULL, &kb_layout_size, kb_layout);
if (ret != EFI_INVALID_PARAMETER) {
efi_st_error("get_keyboard_layout returned %u\n",
(unsigned int)ret);
goto out;
}
result = EFI_ST_SUCCESS;
out:
if (handle1) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle1);
if (ret != EFI_SUCCESS)
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
}
if (handle2) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle2);
if (ret != EFI_SUCCESS)
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
}
return result;
}
/**
* test_hii_database_set_keyboard_layout() - test change of
* current keyboard layout
*
* @Return: status code
*/
static int test_hii_database_set_keyboard_layout(void)
{
PRINT_TESTNAME;
/* set_keyboard_layout() not implemented yet */
return EFI_ST_SUCCESS;
}
/**
* test_hii_database_get_package_list_handle() - test retrieval of
* driver associated with a package list
*
* This test adds a package list, and then tries to get a handle to driver
* which is associated with a package list.
*
* @Return: status code
*/
static int test_hii_database_get_package_list_handle(void)
{
efi_hii_handle_t handle = NULL;
efi_handle_t driver_handle;
efi_status_t ret;
int result = EFI_ST_FAILURE;
PRINT_TESTNAME;
driver_handle = (efi_handle_t)0x12345678; /* dummy */
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist1,
driver_handle, &handle);
if (ret != EFI_SUCCESS || !handle) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
driver_handle = NULL;
ret = hii_database_protocol->get_package_list_handle(
hii_database_protocol, handle, &driver_handle);
if (ret != EFI_SUCCESS || driver_handle != (efi_handle_t)0x12345678) {
efi_st_error("get_package_list_handle returned %u, driver:%p\n",
(unsigned int)ret, driver_handle);
goto out;
}
result = EFI_ST_SUCCESS;
out:
if (handle) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle);
if (ret != EFI_SUCCESS) {
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
}
return result;
}
static int test_hii_database_protocol(void)
{
int ret;
ret = test_hii_database_new_package_list();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_database_update_package_list();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_database_list_package_lists();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_database_export_package_lists();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_database_register_package_notify();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_database_unregister_package_notify();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_database_find_keyboard_layouts();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_database_get_keyboard_layout();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_database_set_keyboard_layout();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_database_get_package_list_handle();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
return EFI_ST_SUCCESS;
}
/*
* HII string protocol tests
*/
/**
* test_hii_string_new_string() - test creation of a new string entry
*
* This test adds a package list, and then tries to add a new string
* entry for a specific language.
*
* @Return: status code
*/
static int test_hii_string_new_string(void)
{
efi_hii_handle_t handle = NULL;
efi_string_id_t id;
efi_status_t ret;
int result = EFI_ST_FAILURE;
PRINT_TESTNAME;
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist1,
NULL, &handle);
if (ret != EFI_SUCCESS || !handle) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
ret = hii_string_protocol->new_string(hii_string_protocol, handle,
&id, (u8 *)"en-US",
L"Japanese", L"Japanese", NULL);
if (ret != EFI_SUCCESS) {
efi_st_error("new_string returned %u\n",
(unsigned int)ret);
goto out;
}
efi_st_printf("new string id is %u\n", id);
result = EFI_ST_SUCCESS;
out:
if (handle) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle);
if (ret != EFI_SUCCESS) {
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
}
return result;
}
/**
* test_hii_string_get_string() - test retrieval of a string entry
*
* This test adds a package list, create a new string entry and then tries
* to get it with its string id.
*
* @Return: status code
*/
static int test_hii_string_get_string(void)
{
efi_hii_handle_t handle = NULL;
efi_string_id_t id;
efi_string_t string;
efi_uintn_t string_len;
efi_status_t ret;
int result = EFI_ST_FAILURE;
PRINT_TESTNAME;
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist1,
NULL, &handle);
if (ret != EFI_SUCCESS || !handle) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
ret = hii_string_protocol->new_string(hii_string_protocol, handle,
&id, (u8 *)"en-US",
L"Japanese", L"Japanese", NULL);
if (ret != EFI_SUCCESS) {
efi_st_error("new_string returned %u\n",
(unsigned int)ret);
goto out;
}
string = NULL;
string_len = 0;
ret = hii_string_protocol->get_string(hii_string_protocol,
(u8 *)"en-US", handle, id, string, &string_len, NULL);
if (ret != EFI_BUFFER_TOO_SMALL) {
efi_st_error("get_string returned %u\n",
(unsigned int)ret);
goto out;
}
string_len += sizeof(u16);
ret = boottime->allocate_pool(EFI_LOADER_DATA, string_len,
(void **)&string);
if (ret != EFI_SUCCESS) {
efi_st_error("AllocatePool failed\n");
goto out;
}
ret = hii_string_protocol->get_string(hii_string_protocol,
(u8 *)"en-US", handle, id, string, &string_len, NULL);
if (ret != EFI_SUCCESS) {
efi_st_error("get_string returned %u\n",
(unsigned int)ret);
goto out;
}
if (efi_st_strcmp_16_8(string, "Japanese")) {
efi_st_error("get_string returned incorrect string\n");
goto out;
}
result = EFI_ST_SUCCESS;
out:
if (handle) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle);
if (ret != EFI_SUCCESS) {
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
}
return result;
}
/**
* test_hii_string_set_string() - test change of a string entry
*
* This test adds a package list, create a new string entry and then tries
* to modify it.
*
* @Return: status code
*/
static int test_hii_string_set_string(void)
{
efi_hii_handle_t handle = NULL;
efi_string_id_t id;
efi_status_t ret;
int result = EFI_ST_FAILURE;
PRINT_TESTNAME;
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist1,
NULL, &handle);
if (ret != EFI_SUCCESS || !handle) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
ret = hii_string_protocol->new_string(hii_string_protocol, handle,
&id, (u8 *)"en-US",
L"Japanese", L"Japanese", NULL);
if (ret != EFI_SUCCESS) {
efi_st_error("new_string returned %u\n",
(unsigned int)ret);
goto out;
}
ret = hii_string_protocol->set_string(hii_string_protocol, handle,
id, (u8 *)"en-US",
L"Nihongo", NULL);
if (ret != EFI_SUCCESS) {
efi_st_error("set_string returned %u\n",
(unsigned int)ret);
goto out;
}
result = EFI_ST_SUCCESS;
out:
if (handle) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle);
if (ret != EFI_SUCCESS) {
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
}
return result;
}
/**
* test_hii_string_get_languages() - test listing of languages
*
* This test adds a package list, and then tries to enumerate languages
* in it. We will get an string of language names.
*
* @Return: status code
*/
static int test_hii_string_get_languages(void)
{
efi_hii_handle_t handle = NULL;
u8 *languages;
efi_uintn_t languages_len;
efi_status_t ret;
int result = EFI_ST_FAILURE;
PRINT_TESTNAME;
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist1,
NULL, &handle);
if (ret != EFI_SUCCESS || !handle) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
languages = NULL;
languages_len = 0;
ret = hii_string_protocol->get_languages(hii_string_protocol, handle,
languages, &languages_len);
if (ret != EFI_BUFFER_TOO_SMALL) {
efi_st_error("get_languages returned %u\n",
(unsigned int)ret);
goto out;
}
ret = boottime->allocate_pool(EFI_LOADER_DATA, languages_len,
(void **)&languages);
if (ret != EFI_SUCCESS) {
efi_st_error("AllocatePool failed\n");
goto out;
}
ret = hii_string_protocol->get_languages(hii_string_protocol, handle,
languages, &languages_len);
if (ret != EFI_SUCCESS) {
efi_st_error("get_languages returned %u\n",
(unsigned int)ret);
goto out;
}
efi_st_printf("got languages are %s\n", languages);
result = EFI_ST_SUCCESS;
out:
if (handle) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle);
if (ret != EFI_SUCCESS) {
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
}
return result;
}
/**
* test_hii_string_get_secondary_languages() - test listing of secondary
* languages
*
* This test adds a package list, and then tries to enumerate secondary
* languages with a specific language. We will get an string of language names.
*
* @Return: status code
*/
static int test_hii_string_get_secondary_languages(void)
{
efi_hii_handle_t handle = NULL;
u8 *languages;
efi_uintn_t languages_len;
efi_status_t ret;
int result = EFI_ST_FAILURE;
PRINT_TESTNAME;
ret = hii_database_protocol->new_package_list(hii_database_protocol,
(struct efi_hii_package_list_header *)packagelist1,
NULL, &handle);
if (ret != EFI_SUCCESS || !handle) {
efi_st_error("new_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
languages = NULL;
languages_len = 0;
ret = hii_string_protocol->get_secondary_languages(hii_string_protocol,
handle, (u8 *)"en-US", languages, &languages_len);
if (ret == EFI_NOT_FOUND) {
efi_st_printf("no secondary languages\n");
result = EFI_ST_SUCCESS;
goto out;
}
if (ret != EFI_BUFFER_TOO_SMALL) {
efi_st_error("get_secondary_languages returned %u\n",
(unsigned int)ret);
goto out;
}
ret = boottime->allocate_pool(EFI_LOADER_DATA, languages_len,
(void **)&languages);
if (ret != EFI_SUCCESS) {
efi_st_error("AllocatePool failed\n");
goto out;
}
ret = hii_string_protocol->get_secondary_languages(hii_string_protocol,
handle, (u8 *)"en-US", languages, &languages_len);
if (ret != EFI_SUCCESS) {
efi_st_error("get_secondary_languages returned %u\n",
(unsigned int)ret);
goto out;
}
efi_st_printf("got secondary languages are %s\n", languages);
result = EFI_ST_SUCCESS;
out:
if (handle) {
ret = hii_database_protocol->remove_package_list(
hii_database_protocol, handle);
if (ret != EFI_SUCCESS) {
efi_st_error("remove_package_list returned %u\n",
(unsigned int)ret);
return EFI_ST_FAILURE;
}
}
return result;
}
static int test_hii_string_protocol(void)
{
int ret;
ret = test_hii_string_new_string();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_string_get_string();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_string_set_string();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_string_get_languages();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
ret = test_hii_string_get_secondary_languages();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
return EFI_ST_SUCCESS;
}
/*
* Execute unit test.
*
* Return: EFI_ST_SUCCESS for success, EFI_ST_FAILURE for failure
*/
static int execute(void)
{
int ret;
/* HII database protocol */
ret = test_hii_database_protocol();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
/* HII string protocol */
ret = test_hii_string_protocol();
if (ret != EFI_ST_SUCCESS)
return EFI_ST_FAILURE;
return EFI_ST_SUCCESS;
}
EFI_UNIT_TEST(hii) = {
.name = "HII database protocols",
.phase = EFI_EXECUTE_BEFORE_BOOTTIME_EXIT,
.setup = setup,
.execute = execute,
};
|