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
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
|
// SPDX-License-Identifier: GPL-2.0+
/*
* Menu-driven UEFI Variable maintenance
*
* Copyright (c) 2022 Masahisa Kojima, Linaro Limited
*/
#include <ansi.h>
#include <common.h>
#include <charset.h>
#include <efi_loader.h>
#include <efi_load_initrd.h>
#include <efi_config.h>
#include <efi_variable.h>
#include <log.h>
#include <malloc.h>
#include <menu.h>
#include <sort.h>
#include <watchdog.h>
#include <asm/unaligned.h>
#include <linux/delay.h>
static struct efi_simple_text_input_protocol *cin;
#define EFICONFIG_DESCRIPTION_MAX 32
#define EFICONFIG_OPTIONAL_DATA_MAX 64
/**
* struct eficonfig_filepath_info - structure to be used to store file path
*
* @name: file or directory name
* @list: list structure
*/
struct eficonfig_filepath_info {
char *name;
struct list_head list;
};
/**
* struct eficonfig_boot_option - structure to be used for updating UEFI boot option
*
* @file_info: user selected file info
* @initrd_info: user selected initrd file info
* @boot_index: index of the boot option
* @description: pointer to the description string
* @optional_data: pointer to the optional_data
* @edit_completed: flag indicates edit complete
*/
struct eficonfig_boot_option {
struct eficonfig_select_file_info file_info;
struct eficonfig_select_file_info initrd_info;
unsigned int boot_index;
u16 *description;
u16 *optional_data;
bool edit_completed;
};
/**
* struct eficonfig_volume_entry_data - structure to be used to store volume info
*
* @file_info: pointer to file info structure
* @v: pointer to the protocol interface
* @dp: pointer to the device path
*/
struct eficonfig_volume_entry_data {
struct eficonfig_select_file_info *file_info;
struct efi_simple_file_system_protocol *v;
struct efi_device_path *dp;
};
/**
* struct eficonfig_file_entry_data - structure to be used to store file info
*
* @file_info: pointer to file info structure
* @is_directory: flag to identify the directory or file
* @file_name: name of directory or file
*/
struct eficonfig_file_entry_data {
struct eficonfig_select_file_info *file_info;
bool is_directory;
char *file_name;
};
/**
* struct eficonfig_boot_selection_data - structure to be used to select the boot option entry
*
* @boot_index: index of the boot option
* @selected: pointer to store the selected index in the BootOrder variable
*/
struct eficonfig_boot_selection_data {
u16 boot_index;
int *selected;
};
/**
* struct eficonfig_boot_order_data - structure to be used to update BootOrder variable
*
* @boot_index: boot option index
* @active: flag to include the boot option into BootOrder variable
*/
struct eficonfig_boot_order_data {
u32 boot_index;
bool active;
};
/**
* eficonfig_print_msg() - print message
*
* display the message to the user, user proceeds the screen
* with any key press.
*
* @items: pointer to the structure of each menu entry
* @count: the number of menu entry
* @menu_header: pointer to the menu header string
* Return: status code
*/
void eficonfig_print_msg(char *msg)
{
/* Flush input */
while (tstc())
getchar();
printf(ANSI_CURSOR_HIDE
ANSI_CLEAR_CONSOLE
ANSI_CURSOR_POSITION
"%s\n\n Press any key to continue", 3, 4, msg);
getchar();
}
/**
* eficonfig_print_entry() - print each menu entry
*
* @data: pointer to the data associated with each menu entry
*/
static void eficonfig_print_entry(void *data)
{
struct eficonfig_entry *entry = data;
int reverse = (entry->efi_menu->active == entry->num);
/* TODO: support scroll or page for many entries */
/*
* Move cursor to line where the entry will be drawn (entry->num)
* First 3 lines(menu header) + 1 empty line
*/
printf(ANSI_CURSOR_POSITION, entry->num + 4, 7);
if (reverse)
puts(ANSI_COLOR_REVERSE);
printf("%s", entry->title);
if (reverse)
puts(ANSI_COLOR_RESET);
}
/**
* eficonfig_display_statusline() - print status line
*
* @m: pointer to the menu structure
*/
static void eficonfig_display_statusline(struct menu *m)
{
struct eficonfig_entry *entry;
if (menu_default_choice(m, (void *)&entry) < 0)
return;
printf(ANSI_CURSOR_POSITION
"\n%s\n"
ANSI_CURSOR_POSITION ANSI_CLEAR_LINE ANSI_CURSOR_POSITION
" Press UP/DOWN to move, ENTER to select, ESC/CTRL+C to quit"
ANSI_CLEAR_LINE_TO_END ANSI_CURSOR_POSITION ANSI_CLEAR_LINE,
1, 1, entry->efi_menu->menu_header, entry->efi_menu->count + 5, 1,
entry->efi_menu->count + 6, 1, entry->efi_menu->count + 7, 1);
}
/**
* eficonfig_choice_entry() - user key input handler
*
* @data: pointer to the efimenu structure
* Return: key string to identify the selected entry
*/
static char *eficonfig_choice_entry(void *data)
{
int esc = 0;
struct list_head *pos, *n;
struct eficonfig_entry *entry;
enum bootmenu_key key = KEY_NONE;
struct efimenu *efi_menu = data;
while (1) {
bootmenu_loop((struct bootmenu_data *)efi_menu, &key, &esc);
switch (key) {
case KEY_UP:
if (efi_menu->active > 0)
--efi_menu->active;
/* no menu key selected, regenerate menu */
return NULL;
case KEY_DOWN:
if (efi_menu->active < efi_menu->count - 1)
++efi_menu->active;
/* no menu key selected, regenerate menu */
return NULL;
case KEY_SELECT:
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_entry, list);
if (entry->num == efi_menu->active)
return entry->key;
}
break;
case KEY_QUIT:
/* Quit by choosing the last entry */
entry = list_last_entry(&efi_menu->list, struct eficonfig_entry, list);
return entry->key;
default:
/* Pressed key is not valid, no need to regenerate the menu */
break;
}
}
}
/**
* eficonfig_destroy() - destroy efimenu
*
* @efi_menu: pointer to the efimenu structure
*/
void eficonfig_destroy(struct efimenu *efi_menu)
{
struct list_head *pos, *n;
struct eficonfig_entry *entry;
if (!efi_menu)
return;
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_entry, list);
free(entry->title);
list_del(&entry->list);
free(entry);
}
free(efi_menu->menu_header);
free(efi_menu);
}
/**
* eficonfig_process_quit() - callback function for "Quit" entry
*
* @data: pointer to the data
* Return: status code
*/
efi_status_t eficonfig_process_quit(void *data)
{
return EFI_ABORTED;
}
/**
* eficonfig_append_menu_entry() - append menu item
*
* @efi_menu: pointer to the efimenu structure
* @title: pointer to the entry title
* @func: callback of each entry
* @data: pointer to the data to be passed to each entry callback
* Return: status code
*/
efi_status_t eficonfig_append_menu_entry(struct efimenu *efi_menu,
char *title, eficonfig_entry_func func,
void *data)
{
struct eficonfig_entry *entry;
if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX)
return EFI_OUT_OF_RESOURCES;
entry = calloc(1, sizeof(struct eficonfig_entry));
if (!entry)
return EFI_OUT_OF_RESOURCES;
entry->title = title;
sprintf(entry->key, "%d", efi_menu->count);
entry->efi_menu = efi_menu;
entry->func = func;
entry->data = data;
entry->num = efi_menu->count++;
list_add_tail(&entry->list, &efi_menu->list);
return EFI_SUCCESS;
}
/**
* eficonfig_append_quit_entry() - append quit entry
*
* @efi_menu: pointer to the efimenu structure
* Return: status code
*/
efi_status_t eficonfig_append_quit_entry(struct efimenu *efi_menu)
{
char *title;
efi_status_t ret;
title = strdup("Quit");
if (!title)
return EFI_OUT_OF_RESOURCES;
ret = eficonfig_append_menu_entry(efi_menu, title, eficonfig_process_quit, NULL);
if (ret != EFI_SUCCESS)
free(title);
return ret;
}
/**
* eficonfig_create_fixed_menu() - create fixed entry menu structure
*
* @items: pointer to the menu entry item
* @count: the number of menu entry
* Return: pointer to the efimenu structure
*/
void *eficonfig_create_fixed_menu(const struct eficonfig_item *items, int count)
{
u32 i;
char *title;
efi_status_t ret;
struct efimenu *efi_menu;
const struct eficonfig_item *iter = items;
efi_menu = calloc(1, sizeof(struct efimenu));
if (!efi_menu)
return NULL;
INIT_LIST_HEAD(&efi_menu->list);
for (i = 0; i < count; i++, iter++) {
title = strdup(iter->title);
if (!title)
goto out;
ret = eficonfig_append_menu_entry(efi_menu, title, iter->func, iter->data);
if (ret != EFI_SUCCESS) {
free(title);
goto out;
}
}
return efi_menu;
out:
eficonfig_destroy(efi_menu);
return NULL;
}
/**
* eficonfig_process_common() - main handler for UEFI menu
*
* Construct the structures required to show the menu, then handle
* the user input interacting with u-boot menu functions.
*
* @efi_menu: pointer to the efimenu structure
* @menu_header: pointer to the menu header string
* Return: status code
*/
efi_status_t eficonfig_process_common(struct efimenu *efi_menu, char *menu_header)
{
struct menu *menu;
void *choice = NULL;
struct list_head *pos, *n;
struct eficonfig_entry *entry;
efi_status_t ret = EFI_SUCCESS;
if (efi_menu->count > EFICONFIG_ENTRY_NUM_MAX)
return EFI_OUT_OF_RESOURCES;
efi_menu->delay = -1;
efi_menu->active = 0;
if (menu_header) {
efi_menu->menu_header = strdup(menu_header);
if (!efi_menu->menu_header)
return EFI_OUT_OF_RESOURCES;
}
menu = menu_create(NULL, 0, 1, eficonfig_display_statusline,
eficonfig_print_entry, eficonfig_choice_entry,
efi_menu);
if (!menu)
return EFI_INVALID_PARAMETER;
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_entry, list);
if (!menu_item_add(menu, entry->key, entry)) {
ret = EFI_INVALID_PARAMETER;
goto out;
}
}
entry = list_first_entry_or_null(&efi_menu->list, struct eficonfig_entry, list);
if (entry)
menu_default_set(menu, entry->key);
printf(ANSI_CURSOR_HIDE
ANSI_CLEAR_CONSOLE
ANSI_CURSOR_POSITION, 1, 1);
if (menu_get_choice(menu, &choice)) {
entry = choice;
if (entry->func)
ret = entry->func(entry->data);
}
out:
menu_destroy(menu);
printf(ANSI_CLEAR_CONSOLE
ANSI_CURSOR_POSITION
ANSI_CURSOR_SHOW, 1, 1);
return ret;
}
/**
* eficonfig_volume_selected() - handler of volume selection
*
* @data: pointer to the data of selected entry
* Return: status code
*/
static efi_status_t eficonfig_volume_selected(void *data)
{
struct eficonfig_volume_entry_data *info = data;
if (info) {
info->file_info->current_volume = info->v;
info->file_info->dp_volume = info->dp;
}
return EFI_SUCCESS;
}
/**
* eficonfig_create_device_path() - create device path
*
* @dp_volume: pointer to the volume
* @current_path: pointer to the file path u16 string
* Return:
* device path or NULL. Caller must free the returned value
*/
struct efi_device_path *eficonfig_create_device_path(struct efi_device_path *dp_volume,
u16 *current_path)
{
char *p;
void *buf;
efi_uintn_t fp_size;
struct efi_device_path *dp;
struct efi_device_path_file_path *fp;
fp_size = sizeof(struct efi_device_path) +
((u16_strlen(current_path) + 1) * sizeof(u16));
buf = calloc(1, fp_size + sizeof(END));
if (!buf)
return NULL;
fp = buf;
fp->dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
fp->dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
fp->dp.length = (u16)fp_size;
u16_strcpy(fp->str, current_path);
p = buf;
p += fp_size;
*((struct efi_device_path *)p) = END;
dp = efi_dp_append(dp_volume, (struct efi_device_path *)buf);
free(buf);
return dp;
}
/**
* eficonfig_file_selected() - handler of file selection
*
* @data: pointer to the data of selected entry
* Return: status code
*/
static efi_status_t eficonfig_file_selected(void *data)
{
u16 *tmp;
struct eficonfig_file_entry_data *info = data;
if (!info)
return EFI_INVALID_PARAMETER;
if (!strcmp(info->file_name, "..")) {
struct eficonfig_filepath_info *iter;
struct list_head *pos, *n;
int is_last;
char *filepath;
tmp = info->file_info->current_path;
memset(info->file_info->current_path, 0, EFICONFIG_FILE_PATH_BUF_SIZE);
filepath = calloc(1, EFICONFIG_FILE_PATH_MAX);
if (!filepath)
return EFI_OUT_OF_RESOURCES;
list_for_each_safe(pos, n, &info->file_info->filepath_list) {
iter = list_entry(pos, struct eficonfig_filepath_info, list);
is_last = list_is_last(&iter->list, &info->file_info->filepath_list);
if (is_last) {
list_del(&iter->list);
free(iter->name);
free(iter);
break;
}
strlcat(filepath, iter->name, EFICONFIG_FILE_PATH_MAX);
}
utf8_utf16_strcpy(&tmp, filepath);
} else {
size_t new_len;
struct eficonfig_filepath_info *filepath_info;
new_len = u16_strlen(info->file_info->current_path) +
strlen(info->file_name);
if (new_len >= EFICONFIG_FILE_PATH_MAX) {
eficonfig_print_msg("File path is too long!");
return EFI_INVALID_PARAMETER;
}
tmp = &info->file_info->current_path[u16_strlen(info->file_info->current_path)];
utf8_utf16_strcpy(&tmp, info->file_name);
filepath_info = calloc(1, sizeof(struct eficonfig_filepath_info));
if (!filepath_info)
return EFI_OUT_OF_RESOURCES;
filepath_info->name = strdup(info->file_name);
if (!filepath_info->name) {
free(filepath_info);
return EFI_OUT_OF_RESOURCES;
}
list_add_tail(&filepath_info->list, &info->file_info->filepath_list);
if (!info->is_directory)
info->file_info->file_selected = true;
}
return EFI_SUCCESS;
}
/**
* eficonfig_select_volume() - construct the volume selection menu
*
* @file_info: pointer to the file selection structure
* Return: status code
*/
static efi_status_t eficonfig_select_volume(struct eficonfig_select_file_info *file_info)
{
u32 i;
efi_status_t ret;
efi_uintn_t count;
struct efimenu *efi_menu;
struct list_head *pos, *n;
struct efi_handler *handler;
struct eficonfig_entry *entry;
struct efi_device_path *device_path;
efi_handle_t *volume_handles = NULL;
struct efi_simple_file_system_protocol *v;
ret = efi_locate_handle_buffer_int(BY_PROTOCOL, &efi_simple_file_system_protocol_guid,
NULL, &count, (efi_handle_t **)&volume_handles);
if (ret != EFI_SUCCESS) {
eficonfig_print_msg("No block device found!");
return ret;
}
efi_menu = calloc(1, sizeof(struct efimenu));
if (!efi_menu)
return EFI_OUT_OF_RESOURCES;
INIT_LIST_HEAD(&efi_menu->list);
for (i = 0; i < count; i++) {
char *devname;
struct efi_block_io *block_io;
struct eficonfig_volume_entry_data *info;
if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 1)
break;
ret = efi_search_protocol(volume_handles[i],
&efi_simple_file_system_protocol_guid, &handler);
if (ret != EFI_SUCCESS)
continue;
ret = efi_protocol_open(handler, (void **)&v, efi_root, NULL,
EFI_OPEN_PROTOCOL_GET_PROTOCOL);
if (ret != EFI_SUCCESS)
continue;
ret = efi_search_protocol(volume_handles[i], &efi_guid_device_path, &handler);
if (ret != EFI_SUCCESS)
continue;
ret = efi_protocol_open(handler, (void **)&device_path,
efi_root, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);
if (ret != EFI_SUCCESS)
continue;
ret = efi_search_protocol(volume_handles[i], &efi_block_io_guid, &handler);
if (ret != EFI_SUCCESS)
continue;
ret = efi_protocol_open(handler, (void **)&block_io,
efi_root, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);
if (ret != EFI_SUCCESS)
continue;
info = calloc(1, sizeof(struct eficonfig_volume_entry_data));
if (!info) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
devname = calloc(1, BOOTMENU_DEVICE_NAME_MAX);
if (!devname) {
free(info);
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
ret = efi_disk_get_device_name(volume_handles[i], devname,
BOOTMENU_DEVICE_NAME_MAX);
if (ret != EFI_SUCCESS) {
free(info);
goto out;
}
info->v = v;
info->dp = device_path;
info->file_info = file_info;
ret = eficonfig_append_menu_entry(efi_menu, devname, eficonfig_volume_selected,
info);
if (ret != EFI_SUCCESS) {
free(info);
goto out;
}
}
ret = eficonfig_append_quit_entry(efi_menu);
if (ret != EFI_SUCCESS)
goto out;
ret = eficonfig_process_common(efi_menu, " ** Select Volume **");
out:
efi_free_pool(volume_handles);
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_entry, list);
free(entry->data);
}
eficonfig_destroy(efi_menu);
return ret;
}
/**
* sort_file() - sort the file name in ascii order
*
* @data1: pointer to the file entry data
* @data2: pointer to the file entry data
* Return: -1 if the data1 file name is less than data2 file name,
* 0 if both file name match,
* 1 if the data1 file name is greater thant data2 file name.
*/
static int sort_file(const void *arg1, const void *arg2)
{
const struct eficonfig_file_entry_data *data1, *data2;
data1 = *((const struct eficonfig_file_entry_data **)arg1);
data2 = *((const struct eficonfig_file_entry_data **)arg2);
return strcasecmp(data1->file_name, data2->file_name);
}
/**
* eficonfig_create_file_entry() - construct the file menu entry
*
* @efi_menu: pointer to the efimenu structure
* @count: number of the directory and file
* @tmp_infos: pointer to the entry data array
* @f: pointer to the file handle
* @buf: pointer to the buffer to store the directory information
* @file_info: pointer to the file selection structure
* Return: status code
*/
static efi_status_t
eficonfig_create_file_entry(struct efimenu *efi_menu, u32 count,
struct eficonfig_file_entry_data **tmp_infos,
struct efi_file_handle *f, struct efi_file_info *buf,
struct eficonfig_select_file_info *file_info)
{
char *name, *p;
efi_uintn_t len;
efi_status_t ret;
u32 i, entry_num = 0;
struct eficonfig_file_entry_data *info;
EFI_CALL(f->setpos(f, 0));
/* Read directory and construct menu structure */
for (i = 0; i < count; i++) {
if (entry_num >= EFICONFIG_ENTRY_NUM_MAX - 1)
break;
len = sizeof(struct efi_file_info) + EFICONFIG_FILE_PATH_BUF_SIZE;
ret = EFI_CALL(f->read(f, &len, buf));
if (ret != EFI_SUCCESS || len == 0)
break;
info = calloc(1, sizeof(struct eficonfig_file_entry_data));
if (!info) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
/* append '\\' at the end of directory name */
name = calloc(1, utf16_utf8_strlen(buf->file_name) + 2);
if (!name) {
ret = EFI_OUT_OF_RESOURCES;
free(info);
goto out;
}
p = name;
utf16_utf8_strcpy(&p, buf->file_name);
if (buf->attribute & EFI_FILE_DIRECTORY) {
/* filter out u'.' */
if (!u16_strcmp(buf->file_name, u".")) {
free(info);
free(name);
continue;
}
name[u16_strlen(buf->file_name)] = '\\';
info->is_directory = true;
}
info->file_name = name;
info->file_info = file_info;
tmp_infos[entry_num++] = info;
}
qsort(tmp_infos, entry_num, sizeof(*tmp_infos),
(int (*)(const void *, const void *))sort_file);
for (i = 0; i < entry_num; i++) {
ret = eficonfig_append_menu_entry(efi_menu, tmp_infos[i]->file_name,
eficonfig_file_selected, tmp_infos[i]);
if (ret != EFI_SUCCESS)
goto out;
}
out:
return ret;
}
/**
* eficonfig_show_file_selection() - construct the file selection menu
*
* @file_info: pointer to the file selection structure
* @root: pointer to the file handle
* Return: status code
*/
static efi_status_t eficonfig_show_file_selection(struct eficonfig_select_file_info *file_info,
struct efi_file_handle *root)
{
u32 count = 0, i;
efi_uintn_t len;
efi_status_t ret;
struct efimenu *efi_menu;
struct efi_file_handle *f;
struct efi_file_info *buf;
struct eficonfig_file_entry_data **tmp_infos;
buf = calloc(1, sizeof(struct efi_file_info) + EFICONFIG_FILE_PATH_BUF_SIZE);
if (!buf)
return EFI_OUT_OF_RESOURCES;
while (!file_info->file_selected) {
efi_menu = calloc(1, sizeof(struct efimenu));
if (!efi_menu) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
INIT_LIST_HEAD(&efi_menu->list);
ret = EFI_CALL(root->open(root, &f, file_info->current_path,
EFI_FILE_MODE_READ, 0));
if (ret != EFI_SUCCESS) {
eficonfig_print_msg("Reading volume failed!");
free(efi_menu);
ret = EFI_ABORTED;
goto out;
}
/* Count the number of directory entries */
for (;;) {
len = sizeof(struct efi_file_info) + EFICONFIG_FILE_PATH_BUF_SIZE;
ret = EFI_CALL(f->read(f, &len, buf));
if (ret != EFI_SUCCESS || len == 0)
break;
count++;
}
/* allocate array to sort the entry */
tmp_infos = calloc(count, sizeof(*tmp_infos));
if (!tmp_infos) {
ret = EFI_OUT_OF_RESOURCES;
goto err;
}
ret = eficonfig_create_file_entry(efi_menu, count, tmp_infos,
f, buf, file_info);
if (ret != EFI_SUCCESS)
goto err;
ret = eficonfig_append_quit_entry(efi_menu);
if (ret != EFI_SUCCESS)
goto err;
ret = eficonfig_process_common(efi_menu, " ** Select File **");
err:
EFI_CALL(f->close(f));
eficonfig_destroy(efi_menu);
if (tmp_infos) {
for (i = 0; i < count; i++)
free(tmp_infos[i]);
}
free(tmp_infos);
if (ret != EFI_SUCCESS)
break;
}
out:
free(buf);
return ret;
}
/**
* handle_user_input() - handle user input
*
* @buf: pointer to the buffer
* @buf_size: size of the buffer
* @cursor_col: cursor column for user input
* @msg: pointer to the string to display
* Return: status code
*/
static efi_status_t handle_user_input(u16 *buf, int buf_size,
int cursor_col, char *msg)
{
u16 *tmp;
efi_status_t ret;
printf(ANSI_CLEAR_CONSOLE
ANSI_CURSOR_POSITION
"%s"
ANSI_CURSOR_POSITION
" Press ENTER to complete, ESC/CTRL+C to quit",
0, 1, msg, 8, 1);
/* tmp is used to accept user cancel */
tmp = calloc(1, buf_size * sizeof(u16));
if (!tmp)
return EFI_OUT_OF_RESOURCES;
ret = efi_console_get_u16_string(cin, tmp, buf_size, NULL, 4, cursor_col);
if (ret == EFI_SUCCESS)
u16_strcpy(buf, tmp);
free(tmp);
/* to stay the parent menu */
ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret;
return ret;
}
/**
* eficonfig_boot_add_enter_description() - handle user input for description
*
* @data: pointer to the internal boot option structure
* Return: status code
*/
static efi_status_t eficonfig_boot_add_enter_description(void *data)
{
struct eficonfig_boot_option *bo = data;
return handle_user_input(bo->description, EFICONFIG_DESCRIPTION_MAX, 22,
"\n ** Edit Description **\n"
"\n"
" enter description: ");
}
/**
* eficonfig_boot_add_optional_data() - handle user input for optional data
*
* @data: pointer to the internal boot option structure
* Return: status code
*/
static efi_status_t eficonfig_boot_add_optional_data(void *data)
{
struct eficonfig_boot_option *bo = data;
return handle_user_input(bo->optional_data, EFICONFIG_OPTIONAL_DATA_MAX, 24,
"\n ** Edit Optional Data **\n"
"\n"
" enter optional data:");
}
/**
* eficonfig_boot_edit_save() - handler to save the boot option
*
* @data: pointer to the internal boot option structure
* Return: status code
*/
static efi_status_t eficonfig_boot_edit_save(void *data)
{
struct eficonfig_boot_option *bo = data;
if (u16_strlen(bo->description) == 0) {
eficonfig_print_msg("Boot Description is empty!");
bo->edit_completed = false;
return EFI_NOT_READY;
}
if (u16_strlen(bo->file_info.current_path) == 0) {
eficonfig_print_msg("File is not selected!");
bo->edit_completed = false;
return EFI_NOT_READY;
}
bo->edit_completed = true;
return EFI_SUCCESS;
}
/**
* eficonfig_process_clear_file_selection() - callback function for "Clear" entry
*
* @data: pointer to the data
* Return: status code
*/
efi_status_t eficonfig_process_clear_file_selection(void *data)
{
struct eficonfig_select_file_info *file_info = data;
/* clear the existing file information */
file_info->current_volume = NULL;
file_info->current_path[0] = u'\0';
file_info->dp_volume = NULL;
return EFI_ABORTED;
}
static struct eficonfig_item select_file_menu_items[] = {
{"Select File", eficonfig_process_select_file},
{"Clear", eficonfig_process_clear_file_selection},
{"Quit", eficonfig_process_quit},
};
/**
* eficonfig_process_show_file_option() - display select file option
*
* @file_info: pointer to the file information structure
* Return: status code
*/
efi_status_t eficonfig_process_show_file_option(void *data)
{
efi_status_t ret;
struct efimenu *efi_menu;
select_file_menu_items[0].data = data;
select_file_menu_items[1].data = data;
efi_menu = eficonfig_create_fixed_menu(select_file_menu_items,
ARRAY_SIZE(select_file_menu_items));
if (!efi_menu)
return EFI_OUT_OF_RESOURCES;
ret = eficonfig_process_common(efi_menu, " ** Update File **");
if (ret != EFI_SUCCESS) /* User selects "Clear" or "Quit" */
ret = EFI_NOT_READY;
eficonfig_destroy(efi_menu);
return ret;
}
/**
* eficonfig_process_select_file() - handle user file selection
*
* @data: pointer to the data
* Return: status code
*/
efi_status_t eficonfig_process_select_file(void *data)
{
size_t len;
efi_status_t ret;
struct list_head *pos, *n;
struct efi_file_handle *root;
struct eficonfig_filepath_info *item;
struct eficonfig_select_file_info *tmp = NULL;
struct eficonfig_select_file_info *file_info = data;
tmp = calloc(1, sizeof(struct eficonfig_select_file_info));
if (!tmp)
return EFI_OUT_OF_RESOURCES;
tmp->current_path = calloc(1, EFICONFIG_FILE_PATH_BUF_SIZE);
if (!tmp->current_path) {
free(tmp);
return EFI_OUT_OF_RESOURCES;
}
INIT_LIST_HEAD(&tmp->filepath_list);
while (!tmp->file_selected) {
tmp->current_volume = NULL;
memset(tmp->current_path, 0, EFICONFIG_FILE_PATH_BUF_SIZE);
ret = eficonfig_select_volume(tmp);
if (ret != EFI_SUCCESS)
goto out;
if (!tmp->current_volume)
return EFI_INVALID_PARAMETER;
ret = EFI_CALL(tmp->current_volume->open_volume(tmp->current_volume, &root));
if (ret != EFI_SUCCESS)
goto out;
ret = eficonfig_show_file_selection(tmp, root);
if (ret == EFI_ABORTED)
continue;
if (ret != EFI_SUCCESS)
goto out;
}
out:
if (ret == EFI_SUCCESS) {
len = u16_strlen(tmp->current_path);
len = (len >= EFICONFIG_FILE_PATH_MAX) ? (EFICONFIG_FILE_PATH_MAX - 1) : len;
memcpy(file_info->current_path, tmp->current_path, len * sizeof(u16));
file_info->current_path[len] = u'\0';
file_info->current_volume = tmp->current_volume;
file_info->dp_volume = tmp->dp_volume;
}
list_for_each_safe(pos, n, &tmp->filepath_list) {
item = list_entry(pos, struct eficonfig_filepath_info, list);
list_del(&item->list);
free(item->name);
free(item);
}
free(tmp->current_path);
free(tmp);
/* to stay the parent menu */
ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret;
return ret;
}
/**
* eficonfig_get_unused_bootoption() - get unused "Boot####" index
*
* @buf: pointer to the buffer to store boot option variable name
* @buf_size: buffer size
* @index: pointer to store the index in the BootOrder variable
* Return: status code
*/
efi_status_t eficonfig_get_unused_bootoption(u16 *buf, efi_uintn_t buf_size,
unsigned int *index)
{
u32 i;
efi_status_t ret;
efi_uintn_t size;
if (buf_size < u16_strsize(u"Boot####"))
return EFI_BUFFER_TOO_SMALL;
for (i = 0; i <= 0xFFFF; i++) {
size = 0;
efi_create_indexed_name(buf, buf_size, "Boot", i);
ret = efi_get_variable_int(buf, &efi_global_variable_guid,
NULL, &size, NULL, NULL);
if (ret == EFI_BUFFER_TOO_SMALL)
continue;
else
break;
}
if (i > 0xFFFF)
return EFI_OUT_OF_RESOURCES;
*index = i;
return EFI_SUCCESS;
}
/**
* eficonfig_set_boot_option() - set boot option
*
* @varname: pointer to variable name
* @dp: pointer to device path
* @label: pointer to label string
* @optional_data: pointer to optional data
* Return: status code
*/
static efi_status_t eficonfig_set_boot_option(u16 *varname, struct efi_device_path *dp,
efi_uintn_t dp_size, u16 *label, char *optional_data)
{
void *p = NULL;
efi_status_t ret;
efi_uintn_t size;
struct efi_load_option lo;
lo.file_path = dp;
lo.file_path_length = dp_size;
lo.attributes = LOAD_OPTION_ACTIVE;
lo.optional_data = optional_data;
lo.label = label;
size = efi_serialize_load_option(&lo, (u8 **)&p);
if (!size)
return EFI_INVALID_PARAMETER;
ret = efi_set_variable_int(varname, &efi_global_variable_guid,
EFI_VARIABLE_NON_VOLATILE |
EFI_VARIABLE_BOOTSERVICE_ACCESS |
EFI_VARIABLE_RUNTIME_ACCESS,
size, p, false);
free(p);
return ret;
}
/**
* eficonfig_append_bootorder() - append new boot option in BootOrder variable
*
* @index: "Boot####" index to append to BootOrder variable
* Return: status code
*/
efi_status_t eficonfig_append_bootorder(u16 index)
{
u16 *bootorder;
efi_status_t ret;
u16 *new_bootorder = NULL;
efi_uintn_t last, size, new_size;
/* append new boot option */
bootorder = efi_get_var(u"BootOrder", &efi_global_variable_guid, &size);
last = size / sizeof(u16);
new_size = size + sizeof(u16);
new_bootorder = calloc(1, new_size);
if (!new_bootorder) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
memcpy(new_bootorder, bootorder, size);
new_bootorder[last] = index;
ret = efi_set_variable_int(u"BootOrder", &efi_global_variable_guid,
EFI_VARIABLE_NON_VOLATILE |
EFI_VARIABLE_BOOTSERVICE_ACCESS |
EFI_VARIABLE_RUNTIME_ACCESS,
new_size, new_bootorder, false);
if (ret != EFI_SUCCESS)
goto out;
out:
free(bootorder);
free(new_bootorder);
return ret;
}
/**
* create_boot_option_entry() - create boot option entry
*
* @efi_menu: pointer to the efimenu structure
* @title: pointer to the entry title
* @val: pointer to boot option label
* @func: callback of each entry
* @data: pointer to the data to be passed to each entry callback
* Return: status code
*/
static efi_status_t create_boot_option_entry(struct efimenu *efi_menu, char *title, u16 *val,
eficonfig_entry_func func, void *data)
{
u32 len;
char *p, *buf;
len = strlen(title) + 1;
if (val)
len += utf16_utf8_strlen(val);
buf = calloc(1, len);
if (!buf)
return EFI_OUT_OF_RESOURCES;
strcpy(buf, title);
if (val) {
p = buf + strlen(title);
utf16_utf8_strcpy(&p, val);
}
return eficonfig_append_menu_entry(efi_menu, buf, func, data);
}
/**
* prepare_file_selection_entry() - prepare file selection entry
*
* @efi_menu: pointer to the efimenu structure
* @title: pointer to the title string
* @file_info: pointer to the file info
* Return: status code
*/
static efi_status_t prepare_file_selection_entry(struct efimenu *efi_menu, char *title,
struct eficonfig_select_file_info *file_info)
{
u32 len;
efi_status_t ret;
u16 *file_name = NULL, *p;
efi_handle_t handle;
char *devname;
devname = calloc(1, EFICONFIG_VOLUME_PATH_MAX + 1);
if (!devname)
return EFI_OUT_OF_RESOURCES;
/* get the device name only when the user already selected the file path */
handle = efi_dp_find_obj(file_info->dp_volume, NULL, NULL);
if (handle) {
ret = efi_disk_get_device_name(handle, devname, EFICONFIG_VOLUME_PATH_MAX);
if (ret != EFI_SUCCESS)
goto out;
}
/*
* If the preconfigured volume does not exist in the system, display the text
* converted volume device path instead of U-Boot friendly name(e.g. "usb 0:1").
*/
if (!handle && file_info->dp_volume) {
u16 *dp_str;
char *q = devname;
dp_str = efi_dp_str(file_info->dp_volume);
if (dp_str)
utf16_utf8_strncpy(&q, dp_str, EFICONFIG_VOLUME_PATH_MAX);
efi_free_pool(dp_str);
}
/* append u'/' to devname, it is just for display purpose. */
if (file_info->current_path[0] != u'\0' && file_info->current_path[0] != u'/')
strlcat(devname, "/", EFICONFIG_VOLUME_PATH_MAX + 1);
len = strlen(devname);
len += utf16_utf8_strlen(file_info->current_path) + 1;
file_name = calloc(1, len * sizeof(u16));
if (!file_name) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
p = file_name;
utf8_utf16_strcpy(&p, devname);
u16_strlcat(file_name, file_info->current_path, len);
ret = create_boot_option_entry(efi_menu, title, file_name,
eficonfig_process_show_file_option, file_info);
out:
free(devname);
free(file_name);
return ret;
}
/**
* eficonfig_show_boot_option() - prepare menu entry for editing boot option
*
* Construct the structures to create edit boot option menu
*
* @bo: pointer to the boot option
* @header_str: pointer to the header string
* Return: status code
*/
static efi_status_t eficonfig_show_boot_option(struct eficonfig_boot_option *bo,
char *header_str)
{
efi_status_t ret;
struct efimenu *efi_menu;
efi_menu = calloc(1, sizeof(struct efimenu));
if (!efi_menu)
return EFI_OUT_OF_RESOURCES;
INIT_LIST_HEAD(&efi_menu->list);
ret = create_boot_option_entry(efi_menu, "Description: ", bo->description,
eficonfig_boot_add_enter_description, bo);
if (ret != EFI_SUCCESS)
goto out;
ret = prepare_file_selection_entry(efi_menu, "File: ", &bo->file_info);
if (ret != EFI_SUCCESS)
goto out;
ret = prepare_file_selection_entry(efi_menu, "Initrd File: ", &bo->initrd_info);
if (ret != EFI_SUCCESS)
goto out;
ret = create_boot_option_entry(efi_menu, "Optional Data: ", bo->optional_data,
eficonfig_boot_add_optional_data, bo);
if (ret != EFI_SUCCESS)
goto out;
ret = create_boot_option_entry(efi_menu, "Save", NULL,
eficonfig_boot_edit_save, bo);
if (ret != EFI_SUCCESS)
goto out;
ret = create_boot_option_entry(efi_menu, "Quit", NULL,
eficonfig_process_quit, NULL);
if (ret != EFI_SUCCESS)
goto out;
ret = eficonfig_process_common(efi_menu, header_str);
out:
eficonfig_destroy(efi_menu);
return ret;
}
/**
* fill_file_info() - fill the file info from efi_device_path structure
*
* @dp: pointer to the device path
* @file_info: pointer to the file info structure
* @device_dp: pointer to the volume device path
*/
static void fill_file_info(struct efi_device_path *dp,
struct eficonfig_select_file_info *file_info,
struct efi_device_path *device_dp)
{
u16 *file_str, *p;
struct efi_device_path *file_dp = NULL;
efi_dp_split_file_path(dp, &device_dp, &file_dp);
file_info->dp_volume = device_dp;
if (file_dp) {
file_str = efi_dp_str(file_dp);
/*
* efi_convert_device_path_to_text() automatically adds u'/' at the
* beginning of file name, remove u'/' before copying to current_path
*/
p = file_str;
if (p[0] == u'/')
p++;
u16_strcpy(file_info->current_path, p);
efi_free_pool(file_dp);
efi_free_pool(file_str);
}
}
/**
* eficonfig_edit_boot_option() - prepare boot option structure for editing
*
* Construct the boot option structure and copy the existing value
*
* @varname: pointer to the UEFI variable name
* @bo: pointer to the boot option
* @load_option: pointer to the load option
* @load_option_size: size of the load option
* @header_str: pointer to the header string
* Return : status code
*/
static efi_status_t eficonfig_edit_boot_option(u16 *varname, struct eficonfig_boot_option *bo,
void *load_option, efi_uintn_t load_option_size,
char *header_str)
{
size_t len;
efi_status_t ret;
char *tmp = NULL, *p;
struct efi_load_option lo = {0};
efi_uintn_t final_dp_size;
struct efi_device_path *dp = NULL;
efi_uintn_t size = load_option_size;
struct efi_device_path *final_dp = NULL;
struct efi_device_path *device_dp = NULL;
struct efi_device_path *initrd_dp = NULL;
struct efi_device_path *initrd_device_dp = NULL;
const struct efi_initrd_dp id_dp = {
.vendor = {
{
DEVICE_PATH_TYPE_MEDIA_DEVICE,
DEVICE_PATH_SUB_TYPE_VENDOR_PATH,
sizeof(id_dp.vendor),
},
EFI_INITRD_MEDIA_GUID,
},
.end = {
DEVICE_PATH_TYPE_END,
DEVICE_PATH_SUB_TYPE_END,
sizeof(id_dp.end),
}
};
bo->file_info.current_path = calloc(1, EFICONFIG_FILE_PATH_BUF_SIZE);
if (!bo->file_info.current_path) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
bo->initrd_info.current_path = calloc(1, EFICONFIG_FILE_PATH_BUF_SIZE);
if (!bo->file_info.current_path) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
bo->description = calloc(1, EFICONFIG_DESCRIPTION_MAX * sizeof(u16));
if (!bo->description) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
bo->optional_data = calloc(1, EFICONFIG_OPTIONAL_DATA_MAX * sizeof(u16));
if (!bo->optional_data) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
/* copy the preset value */
if (load_option) {
ret = efi_deserialize_load_option(&lo, load_option, &size);
if (ret != EFI_SUCCESS)
goto out;
if (!lo.label) {
ret = EFI_INVALID_PARAMETER;
goto out;
}
/* truncate the long label string */
if (u16_strlen(lo.label) >= EFICONFIG_DESCRIPTION_MAX)
lo.label[EFICONFIG_DESCRIPTION_MAX - 1] = u'\0';
u16_strcpy(bo->description, lo.label);
/* EFI image file path is a first instance */
if (lo.file_path)
fill_file_info(lo.file_path, &bo->file_info, device_dp);
/* Initrd file path(optional) is placed at second instance. */
initrd_dp = efi_dp_from_lo(&lo, &efi_lf2_initrd_guid);
if (initrd_dp) {
fill_file_info(initrd_dp, &bo->initrd_info, initrd_device_dp);
efi_free_pool(initrd_dp);
}
if (size > 0)
memcpy(bo->optional_data, lo.optional_data, size);
}
while (1) {
ret = eficonfig_show_boot_option(bo, header_str);
if (ret == EFI_SUCCESS && bo->edit_completed)
break;
if (ret == EFI_NOT_READY)
continue;
if (ret != EFI_SUCCESS)
goto out;
}
if (bo->initrd_info.dp_volume) {
dp = eficonfig_create_device_path(bo->initrd_info.dp_volume,
bo->initrd_info.current_path);
if (!dp) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
initrd_dp = efi_dp_append((const struct efi_device_path *)&id_dp, dp);
efi_free_pool(dp);
}
dp = eficonfig_create_device_path(bo->file_info.dp_volume, bo->file_info.current_path);
if (!dp) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
final_dp_size = efi_dp_size(dp) + sizeof(END);
if (initrd_dp) {
final_dp = efi_dp_concat(dp, initrd_dp);
final_dp_size += efi_dp_size(initrd_dp) + sizeof(END);
} else {
final_dp = efi_dp_dup(dp);
}
efi_free_pool(dp);
if (!final_dp)
goto out;
if (utf16_utf8_strlen(bo->optional_data)) {
len = utf16_utf8_strlen(bo->optional_data) + 1;
tmp = calloc(1, len);
if (!tmp)
goto out;
p = tmp;
utf16_utf8_strncpy(&p, bo->optional_data, u16_strlen(bo->optional_data));
}
ret = eficonfig_set_boot_option(varname, final_dp, final_dp_size, bo->description, tmp);
out:
free(tmp);
free(bo->optional_data);
free(bo->description);
free(bo->file_info.current_path);
free(bo->initrd_info.current_path);
efi_free_pool(device_dp);
efi_free_pool(initrd_device_dp);
efi_free_pool(initrd_dp);
efi_free_pool(final_dp);
return ret;
}
/**
* eficonfig_process_add_boot_option() - handler to add boot option
*
* @data: pointer to the data for each entry
* Return: status code
*/
static efi_status_t eficonfig_process_add_boot_option(void *data)
{
u16 varname[9];
efi_status_t ret;
struct eficonfig_boot_option *bo = NULL;
bo = calloc(1, sizeof(struct eficonfig_boot_option));
if (!bo)
return EFI_OUT_OF_RESOURCES;
ret = eficonfig_get_unused_bootoption(varname, sizeof(varname), &bo->boot_index);
if (ret != EFI_SUCCESS)
return ret;
ret = eficonfig_edit_boot_option(varname, bo, NULL, 0, " ** Add Boot Option ** ");
if (ret != EFI_SUCCESS)
goto out;
ret = eficonfig_append_bootorder((u16)bo->boot_index);
if (ret != EFI_SUCCESS)
goto out;
out:
free(bo);
/* to stay the parent menu */
ret = (ret == EFI_ABORTED) ? EFI_SUCCESS : ret;
return ret;
}
/**
* eficonfig_process_boot_selected() - handler to select boot option entry
*
* @data: pointer to the data for each entry
* Return: status code
*/
static efi_status_t eficonfig_process_boot_selected(void *data)
{
struct eficonfig_boot_selection_data *info = data;
if (info)
*info->selected = info->boot_index;
return EFI_SUCCESS;
}
/**
* search_bootorder() - search the boot option index in BootOrder
*
* @bootorder: pointer to the BootOrder variable
* @num: number of BootOrder entry
* @target: target boot option index to search
* @index: pointer to store the index of BootOrder variable
* Return: true if exists, false otherwise
*/
static bool search_bootorder(u16 *bootorder, efi_uintn_t num, u32 target, u32 *index)
{
u32 i;
for (i = 0; i < num; i++) {
if (target == bootorder[i]) {
if (index)
*index = i;
return true;
}
}
return false;
}
/**
* eficonfig_add_boot_selection_entry() - add boot option menu entry
*
* @efi_menu: pointer to store the efimenu structure
* @boot_index: boot option index to be added
* @selected: pointer to store the selected boot option index
* Return: status code
*/
static efi_status_t eficonfig_add_boot_selection_entry(struct efimenu *efi_menu,
unsigned int boot_index,
unsigned int *selected)
{
char *buf, *p;
efi_status_t ret;
efi_uintn_t size;
void *load_option;
struct efi_load_option lo;
u16 varname[] = u"Boot####";
struct eficonfig_boot_selection_data *info;
efi_create_indexed_name(varname, sizeof(varname), "Boot", boot_index);
load_option = efi_get_var(varname, &efi_global_variable_guid, &size);
if (!load_option)
return EFI_SUCCESS;
ret = efi_deserialize_load_option(&lo, load_option, &size);
if (ret != EFI_SUCCESS) {
log_warning("Invalid load option for %ls\n", varname);
free(load_option);
return ret;
}
if (size >= sizeof(efi_guid_t) &&
!guidcmp(lo.optional_data, &efi_guid_bootmenu_auto_generated)) {
/*
* auto generated entry has GUID in optional_data,
* skip auto generated entry because it will be generated
* again even if it is edited or deleted.
*/
free(load_option);
return EFI_SUCCESS;
}
info = calloc(1, sizeof(struct eficonfig_boot_selection_data));
if (!info) {
free(load_option);
return EFI_OUT_OF_RESOURCES;
}
buf = calloc(1, utf16_utf8_strlen(lo.label) + 1);
if (!buf) {
free(load_option);
free(info);
return EFI_OUT_OF_RESOURCES;
}
p = buf;
utf16_utf8_strcpy(&p, lo.label);
info->boot_index = boot_index;
info->selected = selected;
ret = eficonfig_append_menu_entry(efi_menu, buf, eficonfig_process_boot_selected, info);
if (ret != EFI_SUCCESS) {
free(load_option);
free(info);
return ret;
}
free(load_option);
return EFI_SUCCESS;
}
/**
* eficonfig_show_boot_selection() - construct boot option menu entry
*
* @selected: pointer to store the selected boot option index
* Return: status code
*/
static efi_status_t eficonfig_show_boot_selection(unsigned int *selected)
{
u32 i;
u16 *bootorder;
efi_status_t ret;
efi_uintn_t num, size;
struct efimenu *efi_menu;
struct list_head *pos, *n;
struct eficonfig_entry *entry;
efi_menu = calloc(1, sizeof(struct efimenu));
if (!efi_menu)
return EFI_OUT_OF_RESOURCES;
bootorder = efi_get_var(u"BootOrder", &efi_global_variable_guid, &size);
INIT_LIST_HEAD(&efi_menu->list);
num = size / sizeof(u16);
/* list the load option in the order of BootOrder variable */
for (i = 0; i < num; i++) {
ret = eficonfig_add_boot_selection_entry(efi_menu, bootorder[i], selected);
if (ret != EFI_SUCCESS)
goto out;
if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 1)
break;
}
/* list the remaining load option not included in the BootOrder */
for (i = 0; i <= 0xFFFF; i++) {
/* If the index is included in the BootOrder, skip it */
if (search_bootorder(bootorder, num, i, NULL))
continue;
ret = eficonfig_add_boot_selection_entry(efi_menu, i, selected);
if (ret != EFI_SUCCESS)
goto out;
if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 1)
break;
}
ret = eficonfig_append_quit_entry(efi_menu);
if (ret != EFI_SUCCESS)
goto out;
ret = eficonfig_process_common(efi_menu, " ** Select Boot Option **");
out:
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_entry, list);
free(entry->data);
}
eficonfig_destroy(efi_menu);
return ret;
}
/**
* eficonfig_process_edit_boot_option() - handler to edit boot option
*
* @data: pointer to the data for each entry
* Return: status code
*/
static efi_status_t eficonfig_process_edit_boot_option(void *data)
{
efi_status_t ret;
efi_uintn_t size;
struct eficonfig_boot_option *bo = NULL;
while (1) {
unsigned int selected;
void *load_option;
u16 varname[] = u"Boot####";
ret = eficonfig_show_boot_selection(&selected);
if (ret != EFI_SUCCESS)
break;
bo = calloc(1, sizeof(struct eficonfig_boot_option));
if (!bo) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
bo->boot_index = selected;
efi_create_indexed_name(varname, sizeof(varname), "Boot", selected);
load_option = efi_get_var(varname, &efi_global_variable_guid, &size);
if (!load_option) {
free(bo);
ret = EFI_NOT_FOUND;
goto out;
}
ret = eficonfig_edit_boot_option(varname, bo, load_option, size,
" ** Edit Boot Option ** ");
free(load_option);
free(bo);
if (ret != EFI_SUCCESS && ret != EFI_ABORTED)
break;
}
out:
/* to stay the parent menu */
ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret;
return ret;
}
/**
* eficonfig_display_change_boot_order() - display the BootOrder list
*
* @efi_menu: pointer to the efimenu structure
* Return: status code
*/
static void eficonfig_display_change_boot_order(struct efimenu *efi_menu)
{
bool reverse;
struct list_head *pos, *n;
struct eficonfig_entry *entry;
printf(ANSI_CLEAR_CONSOLE ANSI_CURSOR_POSITION
"\n ** Change Boot Order **\n"
ANSI_CURSOR_POSITION
" Press UP/DOWN to move, +/- to change order"
ANSI_CURSOR_POSITION
" Press SPACE to activate or deactivate the entry"
ANSI_CURSOR_POSITION
" Select [Save] to complete, ESC/CTRL+C to quit"
ANSI_CURSOR_POSITION ANSI_CLEAR_LINE,
1, 1, efi_menu->count + 5, 1, efi_menu->count + 6, 1,
efi_menu->count + 7, 1, efi_menu->count + 8, 1);
/* draw boot option list */
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_entry, list);
reverse = (entry->num == efi_menu->active);
printf(ANSI_CURSOR_POSITION, entry->num + 4, 7);
if (reverse)
puts(ANSI_COLOR_REVERSE);
if (entry->num < efi_menu->count - 2) {
if (((struct eficonfig_boot_order_data *)entry->data)->active)
printf("[*] ");
else
printf("[ ] ");
}
printf("%s", entry->title);
if (reverse)
puts(ANSI_COLOR_RESET);
}
}
/**
* eficonfig_choice_change_boot_order() - handle the BootOrder update
*
* @efi_menu: pointer to the efimenu structure
* Return: status code
*/
static efi_status_t eficonfig_choice_change_boot_order(struct efimenu *efi_menu)
{
int esc = 0;
struct list_head *pos, *n;
enum bootmenu_key key = KEY_NONE;
struct eficonfig_entry *entry, *tmp;
while (1) {
bootmenu_loop(NULL, &key, &esc);
switch (key) {
case KEY_PLUS:
if (efi_menu->active > 0) {
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_entry, list);
if (entry->num == efi_menu->active)
break;
}
tmp = list_entry(pos->prev, struct eficonfig_entry, list);
entry->num--;
tmp->num++;
list_del(&tmp->list);
list_add(&tmp->list, &entry->list);
}
fallthrough;
case KEY_UP:
if (efi_menu->active > 0)
--efi_menu->active;
return EFI_NOT_READY;
case KEY_MINUS:
if (efi_menu->active < efi_menu->count - 3) {
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_entry, list);
if (entry->num == efi_menu->active)
break;
}
tmp = list_entry(pos->next, struct eficonfig_entry, list);
entry->num++;
tmp->num--;
list_del(&entry->list);
list_add(&entry->list, &tmp->list);
++efi_menu->active;
}
return EFI_NOT_READY;
case KEY_DOWN:
if (efi_menu->active < efi_menu->count - 1)
++efi_menu->active;
return EFI_NOT_READY;
case KEY_SELECT:
/* "Save" */
if (efi_menu->active == efi_menu->count - 2)
return EFI_SUCCESS;
/* "Quit" */
if (efi_menu->active == efi_menu->count - 1)
return EFI_ABORTED;
break;
case KEY_SPACE:
if (efi_menu->active < efi_menu->count - 2) {
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_entry, list);
if (entry->num == efi_menu->active) {
struct eficonfig_boot_order_data *data = entry->data;
data->active = !data->active;
return EFI_NOT_READY;
}
}
}
break;
case KEY_QUIT:
return EFI_ABORTED;
default:
/* Pressed key is not valid, no need to regenerate the menu */
break;
}
}
}
/**
* eficonfig_add_change_boot_order_entry() - add boot order entry
*
* @efi_menu: pointer to the efimenu structure
* @boot_index: boot option index to be added
* @active: flag to include the boot option into BootOrder
* Return: status code
*/
static efi_status_t eficonfig_add_change_boot_order_entry(struct efimenu *efi_menu,
u32 boot_index, bool active)
{
char *title, *p;
efi_status_t ret;
efi_uintn_t size;
void *load_option;
struct efi_load_option lo;
u16 varname[] = u"Boot####";
struct eficonfig_boot_order_data *data;
efi_create_indexed_name(varname, sizeof(varname), "Boot", boot_index);
load_option = efi_get_var(varname, &efi_global_variable_guid, &size);
if (!load_option)
return EFI_SUCCESS;
ret = efi_deserialize_load_option(&lo, load_option, &size);
if (ret != EFI_SUCCESS)
goto out;
data = calloc(1, sizeof(*data));
if (!data) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
title = calloc(1, utf16_utf8_strlen(lo.label) + 1);
if (!title) {
free(data);
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
p = title;
utf16_utf8_strcpy(&p, lo.label);
data->boot_index = boot_index;
data->active = active;
ret = eficonfig_append_menu_entry(efi_menu, title, NULL, data);
if (ret != EFI_SUCCESS) {
free(data);
free(title);
goto out;
}
out:
free(load_option);
return ret;
}
/**
* eficonfig_create_change_boot_order_entry() - create boot order entry
*
* @efi_menu: pointer to the efimenu structure
* @bootorder: pointer to the BootOrder variable
* @num: number of BootOrder entry
* Return: status code
*/
static efi_status_t eficonfig_create_change_boot_order_entry(struct efimenu *efi_menu,
u16 *bootorder, efi_uintn_t num)
{
u32 i;
char *title;
efi_status_t ret;
/* list the load option in the order of BootOrder variable */
for (i = 0; i < num; i++) {
if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 2)
break;
ret = eficonfig_add_change_boot_order_entry(efi_menu, bootorder[i], true);
if (ret != EFI_SUCCESS)
goto out;
}
/* list the remaining load option not included in the BootOrder */
for (i = 0; i < 0xFFFF; i++) {
if (efi_menu->count >= EFICONFIG_ENTRY_NUM_MAX - 2)
break;
/* If the index is included in the BootOrder, skip it */
if (search_bootorder(bootorder, num, i, NULL))
continue;
ret = eficonfig_add_change_boot_order_entry(efi_menu, i, false);
if (ret != EFI_SUCCESS)
goto out;
}
/* add "Save" and "Quit" entries */
title = strdup("Save");
if (!title) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
ret = eficonfig_append_menu_entry(efi_menu, title, NULL, NULL);
if (ret != EFI_SUCCESS)
goto out;
ret = eficonfig_append_quit_entry(efi_menu);
if (ret != EFI_SUCCESS)
goto out;
efi_menu->active = 0;
return EFI_SUCCESS;
out:
return ret;
}
/**
* eficonfig_process_change_boot_order() - handler to change boot order
*
* @data: pointer to the data for each entry
* Return: status code
*/
static efi_status_t eficonfig_process_change_boot_order(void *data)
{
u32 count;
u16 *bootorder;
efi_status_t ret;
efi_uintn_t num, size;
struct list_head *pos, *n;
struct eficonfig_entry *entry;
struct efimenu *efi_menu;
efi_menu = calloc(1, sizeof(struct efimenu));
if (!efi_menu)
return EFI_OUT_OF_RESOURCES;
bootorder = efi_get_var(u"BootOrder", &efi_global_variable_guid, &size);
INIT_LIST_HEAD(&efi_menu->list);
num = size / sizeof(u16);
ret = eficonfig_create_change_boot_order_entry(efi_menu, bootorder, num);
if (ret != EFI_SUCCESS)
goto out;
while (1) {
eficonfig_display_change_boot_order(efi_menu);
ret = eficonfig_choice_change_boot_order(efi_menu);
if (ret == EFI_SUCCESS) {
u16 *new_bootorder;
new_bootorder = calloc(1, (efi_menu->count - 2) * sizeof(u16));
if (!new_bootorder) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
/* create new BootOrder */
count = 0;
list_for_each_safe(pos, n, &efi_menu->list) {
struct eficonfig_boot_order_data *data;
entry = list_entry(pos, struct eficonfig_entry, list);
/* exit the loop when iteration reaches "Save" */
if (!strncmp(entry->title, "Save", strlen("Save")))
break;
data = entry->data;
if (data->active)
new_bootorder[count++] = data->boot_index;
}
size = count * sizeof(u16);
ret = efi_set_variable_int(u"BootOrder", &efi_global_variable_guid,
EFI_VARIABLE_NON_VOLATILE |
EFI_VARIABLE_BOOTSERVICE_ACCESS |
EFI_VARIABLE_RUNTIME_ACCESS,
size, new_bootorder, false);
free(new_bootorder);
goto out;
} else if (ret == EFI_NOT_READY) {
continue;
} else {
goto out;
}
}
out:
free(bootorder);
list_for_each_safe(pos, n, &efi_menu->list) {
entry = list_entry(pos, struct eficonfig_entry, list);
free(entry->data);
}
eficonfig_destroy(efi_menu);
/* to stay the parent menu */
ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret;
return ret;
}
/**
* delete_boot_option() - delete selected boot option
*
* @boot_index: boot option index to delete
* Return: status code
*/
static efi_status_t delete_boot_option(u16 boot_index)
{
u16 *bootorder;
u16 varname[9];
efi_status_t ret;
unsigned int index;
efi_uintn_t num, size;
efi_create_indexed_name(varname, sizeof(varname),
"Boot", boot_index);
ret = efi_set_variable_int(varname, &efi_global_variable_guid,
0, 0, NULL, false);
if (ret != EFI_SUCCESS) {
log_err("delete boot option(%ls) failed\n", varname);
return ret;
}
/* update BootOrder if necessary */
bootorder = efi_get_var(u"BootOrder", &efi_global_variable_guid, &size);
if (!bootorder)
return EFI_SUCCESS;
num = size / sizeof(u16);
if (!search_bootorder(bootorder, num, boot_index, &index))
return EFI_SUCCESS;
memmove(&bootorder[index], &bootorder[index + 1],
(num - index - 1) * sizeof(u16));
size -= sizeof(u16);
ret = efi_set_variable_int(u"BootOrder", &efi_global_variable_guid,
EFI_VARIABLE_NON_VOLATILE |
EFI_VARIABLE_BOOTSERVICE_ACCESS |
EFI_VARIABLE_RUNTIME_ACCESS,
size, bootorder, false);
return ret;
}
/**
* eficonfig_process_delete_boot_option() - handler to delete boot option
*
* @data: pointer to the data for each entry
* Return: status code
*/
static efi_status_t eficonfig_process_delete_boot_option(void *data)
{
efi_status_t ret;
unsigned int selected;
while (1) {
ret = eficonfig_show_boot_selection(&selected);
if (ret == EFI_SUCCESS)
ret = delete_boot_option(selected);
if (ret != EFI_SUCCESS)
break;
}
/* to stay the parent menu */
ret = (ret == EFI_ABORTED) ? EFI_NOT_READY : ret;
return ret;
}
/**
* eficonfig_enumerate_boot_option() - enumerate the possible bootable media
*
* @opt: pointer to the media boot option structure
* @volume_handles: pointer to the efi handles
* @count: number of efi handle
* Return: status code
*/
efi_status_t eficonfig_enumerate_boot_option(struct eficonfig_media_boot_option *opt,
efi_handle_t *volume_handles, efi_status_t count)
{
u32 i;
struct efi_handler *handler;
efi_status_t ret = EFI_SUCCESS;
for (i = 0; i < count; i++) {
u16 *p;
u16 dev_name[BOOTMENU_DEVICE_NAME_MAX];
char *optional_data;
struct efi_load_option lo;
char buf[BOOTMENU_DEVICE_NAME_MAX];
struct efi_device_path *device_path;
ret = efi_search_protocol(volume_handles[i], &efi_guid_device_path, &handler);
if (ret != EFI_SUCCESS)
continue;
ret = efi_protocol_open(handler, (void **)&device_path,
efi_root, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);
if (ret != EFI_SUCCESS)
continue;
ret = efi_disk_get_device_name(volume_handles[i], buf, BOOTMENU_DEVICE_NAME_MAX);
if (ret != EFI_SUCCESS)
continue;
p = dev_name;
utf8_utf16_strncpy(&p, buf, strlen(buf));
lo.label = dev_name;
lo.attributes = LOAD_OPTION_ACTIVE;
lo.file_path = device_path;
lo.file_path_length = efi_dp_size(device_path) + sizeof(END);
/*
* Set the dedicated guid to optional_data, it is used to identify
* the boot option that automatically generated by the bootmenu.
* efi_serialize_load_option() expects optional_data is null-terminated
* utf8 string, so set the "1234567" string to allocate enough space
* to store guid, instead of realloc the load_option.
*/
lo.optional_data = "1234567";
opt[i].size = efi_serialize_load_option(&lo, (u8 **)&opt[i].lo);
if (!opt[i].size) {
ret = EFI_OUT_OF_RESOURCES;
goto out;
}
/* set the guid */
optional_data = (char *)opt[i].lo + (opt[i].size - u16_strsize(u"1234567"));
memcpy(optional_data, &efi_guid_bootmenu_auto_generated, sizeof(efi_guid_t));
}
out:
return ret;
}
/**
* eficonfig_delete_invalid_boot_option() - delete non-existing boot option
*
* @opt: pointer to the media boot option structure
* @count: number of media boot option structure
* Return: status code
*/
efi_status_t eficonfig_delete_invalid_boot_option(struct eficonfig_media_boot_option *opt,
efi_status_t count)
{
u32 i, j;
efi_uintn_t size;
void *load_option;
struct efi_load_option lo;
u16 varname[] = u"Boot####";
efi_status_t ret = EFI_SUCCESS;
for (i = 0; i <= 0xFFFF; i++) {
efi_uintn_t tmp;
efi_create_indexed_name(varname, sizeof(varname), "Boot", i);
load_option = efi_get_var(varname, &efi_global_variable_guid, &size);
if (!load_option)
continue;
tmp = size;
ret = efi_deserialize_load_option(&lo, load_option, &size);
if (ret != EFI_SUCCESS)
goto next;
if (size >= sizeof(efi_guid_bootmenu_auto_generated)) {
if (guidcmp(lo.optional_data, &efi_guid_bootmenu_auto_generated) == 0) {
for (j = 0; j < count; j++) {
if (opt[j].size == tmp &&
memcmp(opt[j].lo, load_option, tmp) == 0) {
opt[j].exist = true;
break;
}
}
if (j == count) {
ret = delete_boot_option(i);
if (ret != EFI_SUCCESS) {
free(load_option);
goto out;
}
}
}
}
next:
free(load_option);
}
out:
return ret;
}
/**
* eficonfig_generate_media_device_boot_option() - generate the media device boot option
*
* This function enumerates all devices supporting EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
* and generate the bootmenu entries.
* This function also provide the BOOT#### variable maintenance for
* the media device entries.
* - Automatically create the BOOT#### variable for the newly detected device,
* this BOOT#### variable is distinguished by the special GUID
* stored in the EFI_LOAD_OPTION.optional_data
* - If the device is not attached to the system, the associated BOOT#### variable
* is automatically deleted.
*
* Return: status code
*/
efi_status_t eficonfig_generate_media_device_boot_option(void)
{
u32 i;
efi_status_t ret;
efi_uintn_t count;
efi_handle_t *volume_handles = NULL;
struct eficonfig_media_boot_option *opt = NULL;
ret = efi_locate_handle_buffer_int(BY_PROTOCOL, &efi_simple_file_system_protocol_guid,
NULL, &count, (efi_handle_t **)&volume_handles);
if (ret != EFI_SUCCESS)
return ret;
opt = calloc(count, sizeof(struct eficonfig_media_boot_option));
if (!opt)
goto out;
/* enumerate all devices supporting EFI_SIMPLE_FILE_SYSTEM_PROTOCOL */
ret = eficonfig_enumerate_boot_option(opt, volume_handles, count);
if (ret != EFI_SUCCESS)
goto out;
/*
* System hardware configuration may vary depending on the user setup.
* The boot option is automatically added by the bootmenu.
* If the device is not attached to the system, the boot option needs
* to be deleted.
*/
ret = eficonfig_delete_invalid_boot_option(opt, count);
if (ret != EFI_SUCCESS)
goto out;
/* add non-existent boot option */
for (i = 0; i < count; i++) {
u32 boot_index;
u16 var_name[9];
if (!opt[i].exist) {
ret = eficonfig_get_unused_bootoption(var_name, sizeof(var_name),
&boot_index);
if (ret != EFI_SUCCESS)
goto out;
ret = efi_set_variable_int(var_name, &efi_global_variable_guid,
EFI_VARIABLE_NON_VOLATILE |
EFI_VARIABLE_BOOTSERVICE_ACCESS |
EFI_VARIABLE_RUNTIME_ACCESS,
opt[i].size, opt[i].lo, false);
if (ret != EFI_SUCCESS)
goto out;
ret = eficonfig_append_bootorder(boot_index);
if (ret != EFI_SUCCESS) {
efi_set_variable_int(var_name, &efi_global_variable_guid,
0, 0, NULL, false);
goto out;
}
}
}
out:
if (opt) {
for (i = 0; i < count; i++)
free(opt[i].lo);
}
free(opt);
efi_free_pool(volume_handles);
return ret;
}
/**
* eficonfig_init() - do required initialization for eficonfig command
*
* Return: status code
*/
static efi_status_t eficonfig_init(void)
{
efi_status_t ret = EFI_SUCCESS;
static bool init;
struct efi_handler *handler;
if (!init) {
ret = efi_search_protocol(efi_root, &efi_guid_text_input_protocol, &handler);
if (ret != EFI_SUCCESS)
return ret;
ret = efi_protocol_open(handler, (void **)&cin, efi_root, NULL,
EFI_OPEN_PROTOCOL_GET_PROTOCOL);
if (ret != EFI_SUCCESS)
return ret;
}
init = true;
return ret;
}
static const struct eficonfig_item maintenance_menu_items[] = {
{"Add Boot Option", eficonfig_process_add_boot_option},
{"Edit Boot Option", eficonfig_process_edit_boot_option},
{"Change Boot Order", eficonfig_process_change_boot_order},
{"Delete Boot Option", eficonfig_process_delete_boot_option},
#if (CONFIG_IS_ENABLED(EFI_SECURE_BOOT) && CONFIG_IS_ENABLED(EFI_MM_COMM_TEE))
{"Secure Boot Configuration", eficonfig_process_secure_boot_config},
#endif
{"Quit", eficonfig_process_quit},
};
/**
* do_eficonfig() - execute `eficonfig` command
*
* @cmdtp: table entry describing command
* @flag: bitmap indicating how the command was invoked
* @argc: number of arguments
* @argv: command line arguments
* Return: status code
*/
static int do_eficonfig(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
{
efi_status_t ret;
struct efimenu *efi_menu;
if (argc > 1)
return CMD_RET_USAGE;
ret = efi_init_obj_list();
if (ret != EFI_SUCCESS) {
log_err("Error: Cannot initialize UEFI sub-system, r = %lu\n",
ret & ~EFI_ERROR_MASK);
return CMD_RET_FAILURE;
}
ret = eficonfig_init();
if (ret != EFI_SUCCESS)
return CMD_RET_FAILURE;
ret = eficonfig_generate_media_device_boot_option();
if (ret != EFI_SUCCESS && ret != EFI_NOT_FOUND)
return ret;
while (1) {
efi_menu = eficonfig_create_fixed_menu(maintenance_menu_items,
ARRAY_SIZE(maintenance_menu_items));
if (!efi_menu)
return CMD_RET_FAILURE;
ret = eficonfig_process_common(efi_menu, " ** UEFI Maintenance Menu **");
eficonfig_destroy(efi_menu);
if (ret == EFI_ABORTED)
break;
}
return CMD_RET_SUCCESS;
}
U_BOOT_CMD(
eficonfig, 1, 0, do_eficonfig,
"provide menu-driven UEFI variable maintenance interface",
""
);
|