summaryrefslogtreecommitdiff
path: root/Core/EM/HddSecurity/IdeSecurity.c
blob: cfa9d890d54cbdc38ae83e90665a9a70d4ca62c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
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
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (C)Copyright 1985-2015, American Megatrends, Inc.         **
//**                                                                  **
//**                       All Rights Reserved.                       **
//**                                                                  **
//**         5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093     **
//**                                                                  **
//**                       Phone: (770)-246-8600                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************

//**********************************************************************
// $Header: /Alaska/SOURCE/Modules/HddSecurity/IdeSecurity.c 43    4/22/15 3:57a Anbuprakashp $
//
// $Revision: 43 $
//
// $Date: 4/22/15 3:57a $
//**********************************************************************
// Revision History
// ----------------
// $Log: /Alaska/SOURCE/Modules/HddSecurity/IdeSecurity.c $
// 
// 43    4/22/15 3:57a Anbuprakashp
// [TAG]  		EIP212319
// [Category]  	Bug Fix
// [Severity]  	Normal
// [Symptom]  	System hang while SW_SMI_AHCI_LOCATE_AHCI_SMM SMI trigger
// after enable SmmChkEn bit
// [RootCause]  	Bootservice call used inside IdeSmm driver which causes
// the Exception
// [Solution]  	Changes made not to use BootService calls inside IdeSmm
// driver
// [Files]  		IdeSecurity.h
// IdeSecurity.c
// IDESMM.c
// 
// 42    3/16/15 5:50a Rameshr
// [TAG]  		EIP208331
// [Category]  	Improvement
// [Description]  	Avoid sending freeze Lock command to the device if the
// HDD already in frozen state
// [Files]  		IdeSecurity.c, HddPassword.c
// 
// 41    6/09/14 9:30a Anbuprakashp
// [TAG]  		EIP172445
// [Category]  	Improvement
// [Description]  	Runtime attribute set for the some of the variable used
// by Aptio-4 HddSecurity driver and needs to be reviewed
// [Files]  		IdeSecurity.c
// 
// 40    4/07/14 2:39a Nimishsv
// [TAG]  		EIP151848
// [Category]  	Improvement
// [Description]  	[HDD security]Clear HDD security data related variable
// when secuirty disabled
// [Files]  		IdeSecurity.c
// 
// 39    3/25/14 6:21a Rameshr
// [TAG]  		EIP160499
// [Category]  	Improvement
// [Description]  	Do not get HDD password variable if HDD is in lock
// state
// [Files]  		IdeSecurity.c
// 
// 38    3/25/14 6:12a Rameshr
// [TAG]  		EIP124591
// [Category]  	Improvement
// [Description]  	Before sending the freeze lock command for the HDD,
// check the Hdd security status (locked or unlocked) and if the hdd is
// unlocked state, send the freeze lock command to hdd
// [Files]  		IdeSecurity.c
// 
// 37    12/18/13 4:05a Srikantakumarp
// [TAG]    EIP127356
// [Category]    Improvement
// [Description]    Flash NVRAM seems to cause HDD can't be unlocked when
// S3 resume.
// [Files]    IdeSecurity.c, IDESMM.c, HddPassword.c, AhciBus.c, AhciBus.h
// 
// 36    1/17/12 12:50a Jittenkumarp
// [TAG]  		EIP78432
// [Category]  	Bug Fix
// [Symptom]  	The password set for OEM_MASTER_PASSWORD_TAG token is not
// authenticated when the token SETUP_PASSWORD_NON_CASE_SENSITIVE is set
// to 1.
// [RootCause]  	When SETUP_PASSWORD_NON_CASE_SENSITIVE  token is 1, input
// password is always converted to Uppercase but  OEM_MASTER_PASSWORD_TAG
// is in lower case.
// [Solution]  	OEM_MASTER_PASSWORD_TAG is converted into Uppercase before
// storing in memory.
// [Files]  		IdSecurity.c
// 
// 35    1/05/12 6:25a Anandakrishnanl
// [TAG]  		EIP79637
// [Category]  	Bug Fix
// [Severity]  	Normal
// [Symptom]  	Enhanced Erase Mode not Working
// [RootCause]  	IdeSecurity Module SecurityEraseUnit did not handle Bit1
// of Control Word to identify if it is a normal erase or Enhanced erase
// [Solution]  	[IdeSecurity Module]SIECURITY ERASE UNIT command needs
// Enhanced mode support
// Code changed from Control &= 0x1; // Bit0 is valid to Control &= 0x3;
// // Bit0 and Bit 1 is valid
// to make EnhancedErase functional.
// [Files]  		IdeSecurity.c
// 
// 34    12/19/11 1:06a Rameshr
// [TAG]  		EIP77527
// [Category]  	Improvement
// [Description]  	IdeSecurity, IdeAcoustic and IdeSmart changes should be
// done based on the Core Version checking.
// [Files]  		IdeSecurity.c, IdeSmart.c , Acoustic.c 
// 
// 33    12/05/11 6:24p Rajkumarkc
// [TAG]           EIP77142 
// [Category]    Improvement
// [Description] Added the function 'IdeNonDataCommandExp' in the
// 'IDE_BUS_PROTOCOL' and removed the existing function
// 'IdeNonDataCommand' for supporting the upper 24bits of LBA.
// [Files]
//     Ata.c, IdeBus.c, Idebus.h, PIDEBus.h, Acoustic.c, IdeSecurity.c,
// IdeSMART.c
// 
// 32    10/21/11 4:11a Rameshr
// [TAG]  		EIP69247
// [Category]  	Bug Fix
// [Severity]  	Minor
// [Symptom]  	Several IdeSecurity.sdl tokens are not working properly
// [RootCause]  	Several IdeSecurity.sdl tokens are not working properly
// [Solution]  	Removed unwanted SDL token and verified all the SDL token
// function.
// [Files]  		IdeSecurity.c, IdeSecurity.sdl, IdeSecurity.sdl
// 
// 31    10/21/11 2:22a Rameshr
// [TAG]  		EIP70395
// [Category]  	Bug Fix
// [Severity]  	Minor
// [Symptom]  	When an Empty Master Password string is entered for the
// first time(when no password was installed before), the
// IDEPasswordUpdateHdd returns a  Boolean "TRUE"
// [RootCause]  	SecurityDisablePassword function returns the status of
// SetDefaultMasterPassword function which is EFI_SUCCESS instead of
// returning the status of SecurityCommonRoutine which will fail.
// [Solution]  	SecurityCommonRoutine function status returned as the
// status for SecurityDisablePassword function.
// [Files]  		IdeSecurity.c
// 
// 30    10/11/11 1:54a Rameshr
// [TAG]  		EIP69246
// [Category]  	Improvement
// [Description]  	Made the  SECURITY_SUPPORT as the Master token and
// removed the IdeSecurity_Support token.
// 
// [Files]  		IdeSecurity.c, IdeSecurity.h, IdeSecurity.mak,
// IdeSecurity.sdl
// 
// 29    10/11/11 1:34a Rameshr
// [TAG]  		EIP70918
// [Category]  	Bug Fix
// [Severity]  	Minor
// [Symptom]  	On S3 resume system will throw blue screen error, when HDD
// password is set
// [RootCause]  	Ld assume that the data is UINT64. But the actual data is
// UINT32.
// [Solution]  	To display d should be enough as the DataId is UINT32
// [Files]  		IdeSecurity.c
// 
// 28    4/27/11 6:03a Anandakrishnanl
// [TAG]  		EIP54315 
// [Category]  	Bug Fix
// [Severity]  	Important
// [Symptom]  	SugarBay IdeSecurity increase S3 Resume time
// [RootCause]  	Setting the MASTER_PASSWORD_ENABLE sdl token in Ide
// security Module saves the password in Smm all the time in reboots. This
// causes the system to ask for master password even when it is not locked
// which causes Long Timeout in S3 resume.
// [Solution]  	Fix by not saving the master pasword in SMM at  the time
// of Set password. Only Unlock password will save validated password in
// SMM area.
// [Files]  		IdeSecurity.c
// 
// 27    4/06/11 12:52a Rameshr
// [TAG]- EIP 57341
// [Category]-IMPROVEMENT
// [Description]- Added Support for SMM PI 1.1 in HDDSecurity eModule.
// [Files]- IdeSecurity.c , IdeSecurity.h, IdeSecurity.dxs 
// 
// 26    12/03/10 12:23a Rameshr
// [TAG] - EIP 48770
// [Category]- BUG FIX
// [Severity]- Minor
// [Symptom] - HddSecurity build error when disable the IDEBUS module..
// [RootCause]- IdebusLib used with IdeSecurity Module.
// [Solution] - Removed IdebusLib usage from source and mak file.
// [Files] - Idesecurity.c, IdeSecurity.mak
// 
// 25    10/20/10 2:49a Rameshr
// [TAG]- EIP 43492
// [Category]-IMPROVEMENT
// [Description]- Added the INTEL_IDE_PROTOCOL also to support old Core
// and drivers.
// [Files]- IdeSecurity.c
// 
// 24    10/11/10 6:36p Krishnakumarg
// [TAG] - EIP 44603
// [Category] - Enhancement
// [Severity] - Minor
// [Symptom]  - No Hdd Password in Nvram once enable
// FORCE_HDD_PASSWORD_PROMPT
// [RootCause]- Password not stored in NVRAM on enabling the
// FORCE_HDD_PASSWORD_PROMPT token.
// [Solution] - Password will be stored in nvram based on
// HDD_PASSWORD_ON_NVRAM token.
// [Files] - IdeSecurity.c, IdeSecurity.sdl
// 
// 23    10/11/10 10:59a Krishnakumarg
// [TAG]- EIP 43249
// [Category]-IMPROVEMENT
// [Description]- Non-Ascii character in comments causing build problem in
// japanese XP
// [Files]- IdeSecurity.c,IDESMM.c, InstallIdeSmi, Ata.c, Atapi.c,
// IDEBusComponentName.c, IdeBusMaster.c, IdeHPA.c, IdePowerManagement.c
// 
// 22    9/13/10 1:37a Rameshr
// [TAG]- EIP 43299
// [Category]-IMPROVEMENT
// [Description]- About IdeSecurity module. It use soft smi port 0xb2
// directly.It will need to re-modify on all of AMD project.
//                1) Added the SDL token for Sw SMI port address.
//                2) Used Pciio protocol to get the device location and
// passed this information to SMM driver.
// [Files]- IdeSecurity.c, IdeSmm.c, PideBus.h
// 
// 21    9/13/10 1:31a Rameshr
// [TAG]- EIP 43492
// [Category]-IMPROVEMENT
// [Description]- Change the INTEL_IDE_PROTOCOL into EFI_IDE_PROTOCOL in
// IdeSecurity.c 
// [Files]- IdeSecurity.c
// 
// 20    6/07/10 7:18p Krishnakumarg
// Build error in "4.6.3_HddSecurity_011" label.EIP#39531
// 
// 19    5/06/10 4:39p Yul
// Refer to EIP 37975 IdeSecurity related fixes.
// 
// 18    2/19/10 12:47p Yul
// Delete the comment out codes
// 
// 17    1/21/10 12:06p Yul
// Refer to EIP 33848.
// LegacyBios protocol is not needed here.
// 
// 16    1/15/10 10:20a Yul
// Coding Standard
//
// 15    12/22/09 3:22p Krishnakumarg
// Update for chm file. Added some more comments in function headers
//
// 14    12/09/09 12:17p Krishnakumarg
// EIP 31797 : IDE Security API documentation. Added comments whereever
// possible and modified files for coding standard
//
// 13    11/25/09 6:02p Krishnakumarg
// Updated the file with comments to comply with AMI coding standard.
//
// 12    10/14/09 12:49p Krishnakumarg
// CloseEvent funtion used instead of a static variable in callback
// routines - EIP 27065
//
// 11    7/09/09 4:52p Fasihm
// Update Identify Data before checking the Security Status of the Hard
// Disk.
//
// 10    4/28/09 6:52p Rameshr
// HDD password support in RAID mode
// EIP:20421
//
// 9     3/31/09 7:02p Davidd
// Added FORCE_HDD_PASSWORD_PROMPT token and Device Configuration Freeze
// Lock programming.
//
// 8     3/29/09 11:11a Rameshr
// Security Erase command timeout value should be from the Identify packet
// command word 89. Added code in Ahci and IDE drivers. So removed the
// Extra timeout checking code from here.
// EIP 20630
//
// 7     3/18/09 11:24a Fredericko
// EIP19618 removed dependency on foundation.lib
//
// 6     3/13/09 3:41p Fredericko
//
// 1     10/17/08 7:28p Fasihm
// This is the Initial check-in for the complete AMI Aptio source for the
// Calpella Crb platform based on Clarksfield and Ibex Peak - M chipsets.
//
// 5     9/15/08 9:01p Rameshraju
// Password Buffer is cleard before saving the password.
//
// 4     4/11/08 4:24p Rameshraju
// 1)Enter the Emptry string for the master password, will set the default
// OEM password and in setup password status will be not installed.
// 2)If the revision code is not 0, then SecuritySetPassword will use
// revision code from the input parameters.
// 3)HddSecutiyData Nvram variable master password cleared when we set
// user password and user password cleared when we set master password.
// 4)When we disable the password, HddSecutiyData Nvram variable also
// updated properly.
// 5)Password lenght stored in HddSecData structure.
//
// 3     4/09/08 4:22p Rameshraju
// Build error resolved when the MASTER_PASSWORD_ENABLED.
//
// 2     10/03/08 6:47p Anandakrishnanl
// Removed FreezeLock related code from SMI for improving the S3 resume
// time.
//
// 1     28/02/08 6:40p Anandakrishnanl
// Created new HddSecurity module.  Isolated IdeSecurity and IdeSmm from
// IdeBus driver to be compatable with the AHCI Bus driver.
//
// 15    10/23/07 4:17p Felixp
// IDE Security support moved from Sources to Binary
//
// 14    9/25/07 3:24p Rameshraju
// Set the OEM default master password when the HDD is in unlocked and Not
// Frozen State
//
// 13    14/08/07 1:57p Anandakrishnanl
// Changes made for:
//     1.  Prompt for current password inside setup.
//     2.  Display HardDisk Security Status information.
//     3.  Master Password Verification Logic modified.
//     4.  Added Password install status in ReturnIdePasswordFlags
// protocol function.
//
// 12    22/06/07 12:40p Anandakrishnanl
// HardDisk Security Support Module Added.
// Need ACPI Module and SB Module and under Core\Include we updated
// Setup.h.
// Also New IdeBus bin module.
//
// 11    13/04/07 3:05p Anandakrishnanl
// Ide Bus Module - Update source files to comply with AMI coding
// standard"!!!
//
// 10    12/20/06 1:25p Felixp
// Warning fixed
//
// 9     12/18/06 11:59a Srinin
// Moved CreateReadytoBootEvent little later so that Ide Controller is
// restored first before HDD is unlocked during S3 Resume.
//
// 8     11/17/06 3:41p Ambikas
//
// 7     10/12/06 9:42a Felixp
// UEFI2.0 compliance: use CreateReadyToBootEvent instead of CreateEvent
//
// 6     3/21/06 4:47p Srinin
// Build error fixed.
//
// 5     3/13/06 2:21a Felixp
//
// 4     1/09/06 11:36a Felixp
//
// 2     12/14/05 3:09p Srinin
// HDD password unlock during S3 resume support added.
//
// 1     12/01/05 9:43a Felixp
//
// 6     3/04/05 11:35a Mandal
//
// 5     1/18/05 3:22p Felixp
// PrintDebugMessage renamed to Trace
//
// 3     1/13/05 4:25p Srinin
// Procedure names modified.
//
// 2     1/10/05 11:31a Srinin
// IDESecurity Interface changed.
//
// 1     1/05/05 11:22a Srinin
// IDE Password Support added.
//
//
//<AMI_FHDR_START>
//---------------------------------------------------------------------------
//
// Name: IDESecurityServices.c
//
// Description:	IDE Security Support
//
//---------------------------------------------------------------------------
//<AMI_FHDR_END>

#include "IdeSecurity.h"



static EFI_GUID                    gHddSecurityInitProtocolGuid
    = HDD_SECURITY_INIT_PROTOCOL_GUID;
static EFI_GUID                    gEfiBootScriptSaveGuid
    = EFI_BOOT_SCRIPT_SAVE_GUID;
static EFI_GUID                    gIdeSecurityPwNvguid
    = IDE_SECURITY_PWNV_GUID;
static EFI_GUID                    gSecurityModeProtocolGuid
    = IDE_SECURITY_INTERFACE_GUID;
static EFI_GUID                    gEfiBlockIoProtocolGuid
    = EFI_BLOCK_IO_PROTOCOL_GUID;

extern EFI_DRIVER_BINDING_PROTOCOL gIdeBusDriverBinding;
extern EFI_EVENT                   gIDEBusEvtMiscSmmFeatures;
EFI_EVENT                          BootEvent = NULL;
EFI_EVENT                          gIDEBusEvtBootScript = NULL;

const CHAR16                       *sOemMasterPasswordTag
    = CONVERT_TO_WSTRING( OEM_MASTER_PASSWORD_TAG );
const CHAR16                       *sDefaultMasterPasswordTag
    = CONVERT_TO_WSTRING( DEFAULT_MASTER_PASSWORD_TAG );

#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)
EFI_SMM_CONTROL2_PROTOCOL   *mSmmCtl=NULL;
#else
EFI_SMM_CONTROL_PROTOCOL    *mSmmCtl=NULL;
#endif

HDD_PASSWORD                    *gHDDPasswordBuffer = NULL;
EFI_SMM_COMMUNICATION_PROTOCOL  *gSmmCommunication = NULL;

#ifdef  SW_SMI_IO_ADDRESS
UINT8   SwSmiPort=SW_SMI_IO_ADDRESS;
#else
//
// Default Sw Smi port 
//
UINT8   SwSmiPort=0xB2;
#endif

EFI_STATUS
HDDPortReset(
    IN VOID     *BusInterface,
    IN BOOLEAN   ModeFlag
);


//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   InstallSecurityInterface
//
// Description: Checks whether the device supports Security mode or not.
//              If yes, installs SecurityProtocol.
//
// Input:
//      IN VOID             *BusInterface,
//      IN BOOLEAN          ModeFlag
//
// Output:
//  EFI_SUCCESS                      : Security Mode supported.
//  EFI_DEVICE_ERROR/EFI_UNSUPPORTED : Not supported.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS InstallSecurityInterface(
    IN VOID    *BusInterface,
    IN BOOLEAN ModeFlag )
{
    EFI_STATUS            Status;
    SECURITY_PROTOCOL     *IdeSecurityInterface;
    EFI_HANDLE            IdeDeviceHandle;
    IDENTIFY_DATA         IdentifyData;

    #if MASTER_PASSWORD_ENABLE
    UINT32                IdePasswordFlags = 0;
    #endif

    IDE_BUS_PROTOCOL      *IdeBusInterface;
    SATA_DEVICE_INTERFACE *SataDevInterface;
    IdeBusInterface  = (IDE_BUS_PROTOCOL*)BusInterface;
    SataDevInterface = (SATA_DEVICE_INTERFACE*)BusInterface;

    if ( ModeFlag == FALSE )
    {
        IdentifyData    = IdeBusInterface->IdeDevice.IdentifyData;
        IdeDeviceHandle = IdeBusInterface->IdeDeviceHandle;
    }
    else {
        IdentifyData    = SataDevInterface->IdentifyData;
        IdeDeviceHandle = SataDevInterface->IdeDeviceHandle;
    }

    if ((IdentifyData.Command_Set_Supported_82 & 0x2)  == 0 )
    {
        return EFI_UNSUPPORTED;
    }

    Status = pBS->AllocatePool( EfiBootServicesData,
                                sizeof(SECURITY_PROTOCOL),
                                (VOID**)&IdeSecurityInterface );

    if ( EFI_ERROR( Status ))
    {
        return Status;
    }

    //
    // gHDDPasswordBuffer is allocated only once. The same buffer will be used for all devices.
    //
    if ( gHDDPasswordBuffer == NULL )
    {
        Status = pBS->AllocatePool( EfiBootServicesData,
                                    sizeof(HDD_PASSWORD),
                                    (VOID**)&gHDDPasswordBuffer );

        if ( EFI_ERROR( Status ))
        {
            return Status;
        }
    }

    if ( ModeFlag == FALSE )
    {
        IdeBusInterface->IdeSecurityInterface = IdeSecurityInterface;
        IdeSecurityInterface->BusInterface    = IdeBusInterface;
    }
    else {
        SataDevInterface->IdeSecurityInterface = IdeSecurityInterface;
        IdeSecurityInterface->BusInterface     = SataDevInterface;
    }

    IdeSecurityInterface->ReturnSecurityStatus    = ReturnSecurityStatus;
    IdeSecurityInterface->SecuritySetPassword     = SecuritySetPassword;
    IdeSecurityInterface->SecurityUnlockPassword  = SecurityUnlockPassword;
    IdeSecurityInterface->SecurityDisablePassword = SecurityDisablePassword;
    IdeSecurityInterface->SecurityFreezeLock      = SecurityFreezeLock;
    IdeSecurityInterface->SecurityEraseUnit       = SecurityEraseUnit;
    IdeSecurityInterface->ReturnIdePasswordFlags  = ReturnIdePasswordFlags;
    IdeSecurityInterface->pHDDPasswordBuffer      = gHDDPasswordBuffer;

    //
    // Set ModeFlag to FALSE if IdeBus else TRUE for Ahci Bus.
    //
    IdeSecurityInterface->ModeFlag = ModeFlag;  // Ide Bus

    //
    //  Install the protocol on the device
    //
    Status = pBS->InstallMultipleProtocolInterfaces(
        &IdeDeviceHandle,
        &gSecurityModeProtocolGuid, IdeSecurityInterface,
        NULL );

    if ( gIDEBusEvtBootScript == NULL )
    {
        //
        // Create event for boot script
        //
        Status = CreateReadyToBootEvent(
            TPL_CALLBACK,
            IdeBusCallbackBootScript,
            NULL,
            &gIDEBusEvtBootScript
            );
        ASSERT_EFI_ERROR( Status );
    }

    //
    // Install the Readytoboot event to locate the AhciSMM protocol interface for IdeSmm driver.
    // AhciSmm protocol is valid only on AHCI mode. Other mode Callback is not needed
    //
    if ((BootEvent == NULL) && (ModeFlag))
    {

        // Send data to SMM.
        Status = pBS->LocateProtocol (&gEfiSmmCommunicationProtocolGuid, NULL, (VOID **) &gSmmCommunication);
        if (EFI_ERROR(Status)) {
            gSmmCommunication=NULL;
        }

        //
        // Create event for boot script
        //
        Status = CreateReadyToBootEvent(
            TPL_CALLBACK,
            LocateAhciSmmServiceEvent,
            NULL,
            &BootEvent
            );
        ASSERT_EFI_ERROR( Status );
    }

    #if MASTER_PASSWORD_ENABLE
    //
    // Check if OEM_DEFAULT_MASTER_PASSWORD is enabled and
    // DISPLAY_MASTER_PASSWORD is Disabled
    //
    Status = ReturnIdePasswordFlags(
        (IDE_SECURITY_PROTOCOL*)IdeSecurityInterface,
        &IdePasswordFlags
        );

    ASSERT_EFI_ERROR( Status );

    if ((IdePasswordFlags & 0x0800) && (!(IdePasswordFlags & 0x0008)))
    {
        Status = OEMSetMasterPassword(
            (IDE_SECURITY_PROTOCOL*)IdeSecurityInterface );
        ASSERT_EFI_ERROR( Status );
    }
    #endif

    return EFI_SUCCESS;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   StopSecurityModeSupport
//
// Description: Stops the security mode support by uninstalling the
//              security interface.
//
// Input:
//      IN VOID             *BusInterface,
//      IN BOOLEAN          ModeFlag
//
// Output:
//  EFI_SUCCESS         : Security Mode supported
//  EFI_DEVICE_ERROR    : Not supported
//
// Referrals: ReturnSecurityStatus
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS StopSecurityModeSupport(
    IN VOID    *BusInterface,
    IN BOOLEAN ModeFlag )
{
    EFI_STATUS            Status;
    EFI_HANDLE            IdeDeviceHandle;
    SECURITY_PROTOCOL     *IdeSecurityInterface;
    IDE_BUS_PROTOCOL      *IdeBusInterface;
    SATA_DEVICE_INTERFACE *SataDevInterface;

    IdeBusInterface  = (IDE_BUS_PROTOCOL*)BusInterface;
    SataDevInterface = (SATA_DEVICE_INTERFACE*)BusInterface;

    if ( ModeFlag == FALSE )
    {
        IdeSecurityInterface = IdeBusInterface->IdeSecurityInterface;
        IdeDeviceHandle      = IdeBusInterface->IdeDeviceHandle;
    }
    else {
        IdeSecurityInterface = SataDevInterface->IdeSecurityInterface;
        IdeDeviceHandle      = SataDevInterface->IdeDeviceHandle;
    }

    if ( IdeSecurityInterface == NULL )
    {
        return EFI_SUCCESS;
    }

    //
    //  Install Devicepath and BLOCK_IO on a new handle
    //
    Status = pBS->UninstallMultipleProtocolInterfaces(
        IdeDeviceHandle,
        &gSecurityModeProtocolGuid,
        IdeSecurityInterface,
        NULL );

    if ( Status == EFI_SUCCESS )
    {
        pBS->FreePool( IdeSecurityInterface );
        IdeSecurityInterface = NULL;
    }

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   IdeBusCallbackBootScript
//
// Description: Saves the IDE registers in a boot script.
//
// Input:
//      IN EFI_EVENT    Event
//      IN VOID         *Context
//
// Output:
//      None
//
// Referrals: SmmHDDPasswordInterface
//
// Notes: Will be called only if HDD loses power in S3 state. A SW SMI will
//        be created during S3 resume, to unlock the HDD and put it in
//        Freeze state.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
VOID IdeBusCallbackBootScript(
    IN EFI_EVENT Event,
    IN VOID      *Context )
{
    EFI_BOOT_SCRIPT_SAVE_PROTOCOL *BootScriptSave;
    EFI_STATUS                    Status;
    UINT8                         Value = SW_SMI_HDD_UNLOCK_PASSWORD;


    Status = pBS->LocateProtocol(
        &gEfiBootScriptSaveGuid,
        NULL,
        &BootScriptSave
        );

    if ( EFI_ERROR( Status ))
    {
        return;
    }

    BOOT_SCRIPT_S3_IO_WRITE_MACRO(
        BootScriptSave,
        EfiBootScriptWidthUint8,
        SwSmiPort,
        1,
        &Value
        );

    //
    //Kill the Event
    //
    pBS->CloseEvent( Event );
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   IdeBusMiscSmmFeatureCallback
//
// Description: Saves the IDE registers in a boot script.
//
// Input:
//      IN EFI_EVENT    Event
//      IN VOID         *Context
//
// Output:
//      None
//
// Referrals: SmmHDDPasswordInterface
//
// Notes: Will be called only if HDD is in AHCI Mode or SWSP is Disabled
//        A SW SMI will be created during S3 resume, to Freeze the HDD in AHCI
//        or Disable SWSP command through Set feature command is Issued.
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

VOID IdeBusMiscSmmFeatureCallback(
    IN EFI_EVENT Event,
    IN VOID      *Context )
{
    EFI_BOOT_SCRIPT_SAVE_PROTOCOL *BootScriptSave;
    EFI_STATUS                    Status;
    UINT8                         Value = SW_SMI_HDD_MISC_SMM_FEATURES;

    static BOOLEAN                S3DataSaved = FALSE;

    if ( S3DataSaved )
    {
        return;
    }

    Status = pBS->LocateProtocol(
        &gEfiBootScriptSaveGuid,
        NULL,
        &BootScriptSave
        );

    if ( EFI_ERROR( Status ))
    {
        return;
    }

    BOOT_SCRIPT_S3_IO_WRITE_MACRO(
        BootScriptSave,
        EfiBootScriptWidthUint8,
        SwSmiPort,
        1,
        &Value
        );

    S3DataSaved = TRUE;
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------------
// Procedure:   IdeSecurityEntryPoint
//
// Description: This function is the entry point for IDE SECURITY Driver.
//
// Input:
//  EFI_HANDLE          ImageHandle     Image handle.
//  EFI_SYSTEM_TABLE    *SystemTable    Pointer to the EFI system table.
//
// Output:
//  EFI_SUCCESS         Security interface installed.
//  EFI_ERROR           Security interface not installed or unable to locate
//                      some protocol.
//
// Notes:
//  Entry Points are used to locate or install protocol interfaces and
//  notification events.
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS IdeSecurityEntryPoint(
    IN EFI_HANDLE       ImageHandle,
    IN EFI_SYSTEM_TABLE *SystemTable )
{
    EFI_HANDLE Handle = NULL;
    EFI_STATUS Status;

    InitAmiLib( ImageHandle, SystemTable );

    Status = pBS->AllocatePool( EfiBootServicesData,
                                sizeof(HDD_SECURITY_INIT_PROTOCOL),
                                (VOID**)&gHddSecurityInitProtocol );

    if ( EFI_ERROR( Status ))
    {
        return Status;
    }

#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)
    Status = pBS->LocateProtocol(&gEfiSmmControl2ProtocolGuid, NULL, &mSmmCtl);
#else
    Status = pBS->LocateProtocol(&gEfiSmmControlProtocolGuid, NULL, &mSmmCtl);
#endif

    if ( EFI_ERROR( Status )) {
        return EFI_UNSUPPORTED;
    }

    gHddSecurityInitProtocol->InstallSecurityInterface
        = InstallSecurityInterface;
    gHddSecurityInitProtocol->StopSecurityModeSupport
        = StopSecurityModeSupport;

    Status = pBS->InstallProtocolInterface(
        &Handle,
        &gHddSecurityInitProtocolGuid,
        EFI_NATIVE_INTERFACE,
        gHddSecurityInitProtocol
        );
    ASSERT_EFI_ERROR( Status );

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   ReturnSecurityStatus
//
// Description: Returns whether the Device supports Security Mode or not.
//              If supported, the current status of the device is returned.
//              Security status information will be retrieved from buffer
//              updated by IDENTIFY DEVICE(Command Code : 0xEC) command.
// Input:
//      IN IDE_SECURITY_PROTOCOL        *This,
//      UINT16                          *SecurityStatus
//
// Output:
//      EFI_SUCCESS                     : Security Mode supported
//      EFI_UNSUPPORTED                 : Not supported
//
//      UINT16                          *SecurityStatus
//                                      Bit 0 : Security Supported
//                                      Bit 1 : Security Enabled
//                                      Bit 2 : Security Locked
//                                      Bit 3 : Security Frozen
//                                      Bit 4 : Security Count Expired
//                                      Bit 5 : Enhanced Security Erase supported
//                                      Bit 6 : Enhanced Security Erase supported
//                                      Bit 8 : Security Level 0:High, 1:Maximum
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS ReturnSecurityStatus(
    IN IDE_SECURITY_PROTOCOL *This,
    UINT16                   *SecurityStatus )
{
    EFI_STATUS            Status = EFI_UNSUPPORTED;
    IDENTIFY_DATA         IdentifyData;
    VOID                  *BusInterface
        = ((SECURITY_PROTOCOL* )This)->BusInterface;
    BOOLEAN               ModeFlag = ((SECURITY_PROTOCOL* )This)->ModeFlag;
    IDE_BUS_PROTOCOL      *IdeBusInterface;
    SATA_DEVICE_INTERFACE *SataDevInterface;

    IdeBusInterface  = (IDE_BUS_PROTOCOL*)BusInterface;
    SataDevInterface = (SATA_DEVICE_INTERFACE*)BusInterface;

    if ( ModeFlag == FALSE )
    {
        IdentifyData = IdeBusInterface->IdeDevice.IdentifyData;
    }
    else {
        IdentifyData = SataDevInterface->IdentifyData;
    }

    //
    //  Check if Word 82 Bit 1 is set
    //
    if ( IdentifyData.Command_Set_Supported_82 & 0x2 )
    {
        Status          = EFI_SUCCESS;
        *SecurityStatus = IdentifyData.Security_Status_128;
    }

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   SecuritySetPassword
//
// Description: Sets User/Master Password using SECURITY_SET_PASSWORD
//              (Commnd Code : 0xF1) security command.
//
// Input:
//      IN IDE_SECURITY_PROTOCOL        *This,
//      UINT16                          Control,
//      UINT8                           *Buffer (32 Bytes)
//      UINT8                           RevisionCode (Valid when Control
//                                       Bit 0 = 1 of Master Password)
//
//  Control : Bit 0 : 0/1 User/Master Password
//            Bit 8 : 0/1 High/Maximum Security level
//
// Output:
//  EFI_SUCCESS     : Password set.
//  EFI_ERROR	    : Error in setting Password.
//
// Notes:
//  1. Buffer should be 32 bytes long (Mandatory). Even if Password is not 32
//     bytes long,pad it with zeros to create a buffer of 32 bytes.
//  2. If a MasterPassword with a valid Revision code(0x0001 through 0xFFFE)
//     already exists, a new MasterPassword with a different revisioncode
//     cannot be installed.MasterPassword needs to be unlocked, disabled and
//     then a new password can be installed.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS SecuritySetPassword(
    IN IDE_SECURITY_PROTOCOL *This,
    UINT16                   Control,
    UINT8                    *Buffer,
    UINT16                   RevisionCode )
{
    EFI_STATUS            Status;

    #if (!DISABLE_SOFT_SET_PREV && !FORCE_HDD_PASSWORD_PROMPT ) || HDD_PASSWORD_ON_NVRAM
    UINT32                HddDataId  = 0;
    UINT16                UserMaster = 0;
    #endif
    UINT16                Temp = 1;

    VOID                  *BusInterface
        = ((SECURITY_PROTOCOL* )This)->BusInterface;
    BOOLEAN               ModeFlag = ((SECURITY_PROTOCOL* )This)->ModeFlag;
    IDENTIFY_DATA         IdentifyData;
    IDE_BUS_PROTOCOL      *IdeBusInterface;
    SATA_DEVICE_INTERFACE *SataDevInterface;

    IdeBusInterface  = (IDE_BUS_PROTOCOL*)BusInterface;
    SataDevInterface = (SATA_DEVICE_INTERFACE*)BusInterface;

    Control &= 0x0101;          // Bit0 and Bit 8 are valid

    //
    //  Update the Identify device buffer
    //
    UpdateIdentifyData( BusInterface, ModeFlag );

    if ( ModeFlag == FALSE )
    {
        IdentifyData = IdeBusInterface->IdeDevice.IdentifyData;
    }
    else {
        IdentifyData = SataDevInterface->IdentifyData;
    }

    if ((Control & 1) && (RevisionCode == 0))
    {
        RevisionCode = DEFAULT_MASTER_PASSWORD_REVISION;

        #if MASTER_PASSWORD_REVISION_SWITCH == 1
        RevisionCode = CHANGED_MASTER_PASSWORD_REVISION;
        #endif

        #if MASTER_PASSWORD_REVISION_SWITCH == 2
        Temp = (IdentifyData.Master_Password_Rev_92)++;

        if ((Temp == 0) || (Temp == 0xFFFF))
        {
            Temp++;

            if ( Temp == 0xFFFF )
            {
                Temp++;
            }
        }
        RevisionCode = Temp;
        #endif

        if ( RevisionCode == DISABLED_MASTER_PASSWORD_REVISION )
        {
            RevisionCode++;

            if ((RevisionCode == 0) || (RevisionCode == 0xFFFF))
            {
                RevisionCode++;

                if ( RevisionCode == 0xFFFF )
                {
                    RevisionCode++;
                }
            }
        }
    }

    Status = SecurityCommonRoutine(
        BusInterface,
        Control,
        Buffer,
        SECURITY_SET_PASSWORD,
        RevisionCode,
        ModeFlag
        );

    //
    //  Update the Identify device buffer
    //
    UpdateIdentifyData( BusInterface, ModeFlag );

    //
    //  If Password is set successfully, save it.
    //
    if ( !EFI_ERROR( Status ))
    {
		if(!(Control & 1)) {
	        SmmHDDPasswordInterface( This,
                                 	Control,
                                 	Buffer,
                                 	SW_SMI_HDD_PASSWORD_SAVE );
		}

        #if (!DISABLE_SOFT_SET_PREV && !FORCE_HDD_PASSWORD_PROMPT ) || HDD_PASSWORD_ON_NVRAM
        Status = GatherIdeInfo( BusInterface, ModeFlag, &HddDataId );
        ASSERT_EFI_ERROR( Status );

        Status = SetHddSecDataInNvram( BusInterface,
                                       &HddDataId,
                                       Control,
                                       Buffer );
        ASSERT_EFI_ERROR( Status );
        #endif
    }

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   SecurityUnlockPassword
//
// Description: Unlocks the devices for media access using
//              SECURITY_UNLOCK(Command Code : 0xF2) security command.
//
// Input:
//      IN IDE_SECURITY_PROTOCOL        *This,
//      UINT16                          Control,
//      UINT8                           *Buffer (32 Bytes).
//
//      Control : Bit 0 : 0/1 User/Master Password
//      Buffer  : Pointer to password buffer which will be used to unlock the
//                drive.
//
// Output:
//  EFI_SUCCESS         : Hard disk is unlocked.
//  EFI_DEVICE_ERROR    : Failed to unlock the drive.
//
// Notes:
//  1. Buffer should be 32 bytes long (Mandatory). Even if Password is not
//     32 bytes long, pad it with zeros to create a buffer of 32 bytes.
//  2. If the password compare fails then the device returns command aborted
//     to the host and decrements the unlock counter. This counter is initially
//     set to five and is decremented for each password mismatch when SECURITY
//     UNLOCK is issued and the device is locked. When this counter reaches
//     zero then SECURITY UNLOCK and SECURITY ERASE UNIT commands are command
//     aborted until a power-on reset or a hardware reset.SECURITY UNLOCK
//     commands issued when the device is unlocked have no effect on the unlock
//     counter.
//  3. SECURITY_DISABLE_PASSWORD and SECURITY_SET_PASSWORD commands used when
//     security password is set and HDD is in unlocked state. This is done to
//     have consistency of output from this function.
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS SecurityUnlockPassword(
    IN IDE_SECURITY_PROTOCOL *This,
    UINT16                   Control,
    UINT8                    *Buffer )
{
    EFI_STATUS            Status;

    #if (!DISABLE_SOFT_SET_PREV && !FORCE_HDD_PASSWORD_PROMPT ) || HDD_PASSWORD_ON_NVRAM
    UINT32                HddDataId  = 0;
    UINT16                UserMaster = 0;
    #endif
    UINT16                RevisionCode = 0;
    EFI_STATUS            Status1;
    VOID                  *BusInterface   \
        = ((SECURITY_PROTOCOL* )This)->BusInterface;
    BOOLEAN               ModeFlag   \
        = ((SECURITY_PROTOCOL* )This)->ModeFlag;
    UINT16                SecurityStatus = 0;
    #if MASTER_PASSWORD_ENABLE
    UINT32                IdePasswordFlags = 0;
    #endif

    IDE_BUS_PROTOCOL      *IdeBusInterface;
    SATA_DEVICE_INTERFACE *SataDevInterface;
    EFI_BLOCK_IO_PROTOCOL *BlockIo;

    IdeBusInterface  = (IDE_BUS_PROTOCOL*)BusInterface;
    SataDevInterface = (SATA_DEVICE_INTERFACE*)BusInterface;

    //
    // Update the Identify device buffer
    //
    UpdateIdentifyData( BusInterface, ModeFlag );

    Status = ReturnSecurityStatus( This, &SecurityStatus );

    Control &= 0x1;         // Bit0 is valid
    //
    // When in Setup, Current Password is prompted for consistency when Setting a New Password
    // Or Disabling the Existing Password. Follow a Special Path only in this case.
    //*****This Case Applies on only when (1)Password is Set & Security Enabled
    //                                    (2)Unlocked


    if ((SecurityStatus & BIT01) && (!(SecurityStatus & BIT02)))
    {
        if ( !(Control & 1))
        {
            //
            // (a)For Changing or Clearing User Password.
            //  1.Send a disable Password Command from the String Obtained from user.
            //  2.If Success Set the Password Same Password.
            //  3.Suitable if Logged in as Both User or Master
            //
            Status = SecurityCommonRoutine(
                BusInterface,
                Control,
                Buffer,
                SECURITY_DISABLE_PASSWORD,
                0,
                ModeFlag
                );

            if ( !EFI_ERROR( Status ))
            {
                SecurityCommonRoutine(
                    BusInterface,
                    Control,
                    Buffer,
                    SECURITY_SET_PASSWORD,
                    RevisionCode,
                    ModeFlag
                    );
            }
            return Status;
        }

    }

    Status = SecurityCommonRoutine(
        BusInterface,
        Control,
        Buffer,
        SECURITY_UNLOCK,
        0,
        ModeFlag
        );

    //
    // Update the Identify device buffer
    //
    UpdateIdentifyData( BusInterface, ModeFlag );

    if ( !EFI_ERROR( Status ))
    {
        //
        // Save the Password if unlocked Successfully.
        //
        SmmHDDPasswordInterface( This,
                                 Control,
                                 Buffer,
                                 SW_SMI_HDD_PASSWORD_SAVE );

        #if (!DISABLE_SOFT_SET_PREV && !FORCE_HDD_PASSWORD_PROMPT ) || HDD_PASSWORD_ON_NVRAM
        Status = GatherIdeInfo( BusInterface, ModeFlag, &HddDataId );
        ASSERT_EFI_ERROR( Status );

        Status = SetHddSecDataInNvram( BusInterface,
                                       &HddDataId,
                                       Control,
                                       Buffer );
        ASSERT_EFI_ERROR( Status );
        #endif

        //
        // After unlock the HDD set the OEM default master password
        // Check if OEM_DEFAULT_MASTER_PASSWORD is enabled and
        // DISPLAY_MASTER_PASSWORD is Disabled.
        //
        #if MASTER_PASSWORD_ENABLE
        Status = ReturnIdePasswordFlags( This, &IdePasswordFlags );
        ASSERT_EFI_ERROR( Status );

        if ((IdePasswordFlags & 0x0800) && (!(IdePasswordFlags & 0x0008)))
        {
            Status = OEMSetMasterPassword( This );
            ASSERT_EFI_ERROR( Status );
        }
        #endif

        if ( ModeFlag == FALSE ) {

            //
            // Check if BlockIO Protocol is already present on this device.
            //
            Status1 = pBS->HandleProtocol(IdeBusInterface->IdeDeviceHandle,
                                          &gEfiBlockIoProtocolGuid,
                                          &BlockIo
                                          );

            //
            // Connect only if BloCkIO protocol is not installed on the device.
            //
            if ( EFI_ERROR( Status1 )) {
                #if EFI_IDE_PROTOCOL || INTEL_IDE_PROTOCOL
                pBS->ConnectController(
                    IdeBusInterface->IdeControllerInterfaceHandle,
                    NULL,
                    NULL,
                    TRUE
                    );
                #else
                pBS->ConnectController(
                    IdeBusInterface->IdeControllerInterface->ControllerHandle,
                    NULL,
                    NULL,
                    TRUE
                    );
                #endif
            }
        }
    }

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   SecurityDisablePassword
//
// Description: Disables Password authentification before media access.
//              SECURITY_DISABLE_PASSWORD(Command Code : 0xF6) security
//              command is used to remove the user password.
//
// Input:
//      IN IDE_SECURITY_PROTOCOL        *This,
//      UINT16                          Control,
//      UINT8                           *Buffer (32 Bytes)
//
//  Control : Bit 0 : 0/1 User/Master Password
//
//  Buffer  : Pointer to password buffer which will be used to when sending
//            SECURITY_DISABLE_PASSWORD command.
//
//
// Output:
//  EFI_SUCCESS      : Security mode feature disabled.
//  EFI_DEVICE_ERROR : Security command failed.
//
// Notes:
//  1. Buffer should be 32 bytes long (Mandatory). Even if Password is not
//     32 bytes long,pad it with zeros to create a buffer of 32 bytes.
//  2. Password should be unlocked before disabling it.
//  3. SECURITY_DISABLE_PASSWORD command does not change the Master password
//     that may be reactivated later by setting a User password.
//  4. Normal erase mode is selected, the SECURITY ERASE UNIT command writes
//     binary zeroes to all user data areas.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS SecurityDisablePassword(
    IN IDE_SECURITY_PROTOCOL *This,
    UINT16                   Control,
    UINT8                    *Buffer )
{
    EFI_STATUS Status;
    VOID       *BusInterface   \
        = ((SECURITY_PROTOCOL* )This)->BusInterface;
    BOOLEAN    ModeFlag  \
        = ((SECURITY_PROTOCOL* )This)->ModeFlag;

    #if (!DISABLE_SOFT_SET_PREV && !FORCE_HDD_PASSWORD_PROMPT ) || HDD_PASSWORD_ON_NVRAM
    UINT32     HddDataId = 0;
    UINT8      EmptyBuffer[IDE_PASSWORD_LENGTH];
    #endif

    Control &= 0x1;             // Bit0 is valid

    #if (!DISABLE_SOFT_SET_PREV && !FORCE_HDD_PASSWORD_PROMPT ) || HDD_PASSWORD_ON_NVRAM
    //
    //Update the Nvram buffer with NULL string.
    //
    pBS->SetMem( EmptyBuffer, IDE_PASSWORD_LENGTH, 0 );

    Status = GatherIdeInfo( BusInterface, ModeFlag, &HddDataId );
    ASSERT_EFI_ERROR( Status );

    Status = SetHddSecDataInNvram( BusInterface, &HddDataId, Control, EmptyBuffer );
    ASSERT_EFI_ERROR( Status );
    #endif

    Status = SecurityCommonRoutine( BusInterface,
                                    Control,
                                    Buffer,
                                    SECURITY_DISABLE_PASSWORD,
                                    0,
                                    ModeFlag
                                    );

    //
    // Update the Identify device buffer
    //
    UpdateIdentifyData( BusInterface, ModeFlag );

    if ( !EFI_ERROR( Status ))
    {
        SmmHDDPasswordInterface( This,
                                 Control,
                                 Buffer,
                                 SW_SMI_HDD_PASSWORD_REMOVE );
    }

    //
    // If the Empty string entered for the master password, Set the OEM
    // disable password with Disabled revision code.
    //
    if ( Control & 01 )
    {
        EFI_STATUS    DefaultStatus;
        DefaultStatus = SetDefaultMasterPassword( This );
        ASSERT_EFI_ERROR( DefaultStatus );
    }
    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   SetDefaultMasterPassword
//
// Description: Sets the Default Password String provided by OEM as
//              Master Password.
//
// Input:
//              IN IDE_SECURITY_PROTOCOL        *This
//
// Output:
//  EFI_SUCCESS : Default master password is set.
//  EFI_ERROR   : Default master password is not set.
//
// Notes:
//  DEFAULT_MASTER_PASSWORD_TAG token string will be set as master password.
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS SetDefaultMasterPassword(
    IN IDE_SECURITY_PROTOCOL *This )
{
    EFI_STATUS Status;
    UINT8      Buffer[IDE_PASSWORD_LENGTH];
    UINT16     Control      = 1;
    UINT16     RevisionCode = DISABLED_MASTER_PASSWORD_REVISION;
    UINTN      i;
    UINT16     SecurityStatus = 0;

    MemSet( &Buffer, IDE_PASSWORD_LENGTH, 0 );

    for ( i = 0; i < IDE_PASSWORD_LENGTH; i++ )
    {
        Buffer[i] = (UINT8)sDefaultMasterPasswordTag[i];

        if ( sDefaultMasterPasswordTag[i] == L'\0' )
        {
            break;
        }
    }
    //
    // Set the OEM master password if the HDD is not in Frozen or locked state.
    //
    Status = ReturnSecurityStatus( This, &SecurityStatus );

    if ( !((SecurityStatus & 0x04) || (SecurityStatus & 0x08)))
    {
        Status = SecuritySetDefaultMasterPassword( This,
                                                   Control,
                                                   Buffer,
                                                   RevisionCode );
    }

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   SecuritySetDefaultMasterPassword
//
// Description: Sets default Master Password with disabled revision code.
//              SECURITY_SET_PASSWORD(Command code : 0xF1) security command
//              used to set default master password.
//
// Input:
//      IN IDE_BUS_PROTOCOL             *This,
//      UINT16                          Control,
//      UINT8                           *Buffer (32 Bytes)
//      UINT8                           RevisionCode (Valid when
//                                      Control Bit 0 = 1 of Master Password)
//
//      Control :       Bit 0 : 0/1 User/Master Password
//                      Bit 8 : 0/1 High/Maximum Security level
//
// Output:
//      EFI_SUCCESS : Password set
//      EFI_ERROR   : Error in setting Password
//
// Notes:
//  1. Buffer should be 32 bytes long (Mandatory). Even if Password is not
//     32 bytes long,pad it with zeros to create a buffer of 32 bytes.
//
//  2. If a MasterPassword with a valid Revision code already exists, a new
//     MasterPassword with a different revisioncode cannot be installed.
//     MasterPassword needs to be unlocked, disabled and then a new password
//     can be installed.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS SecuritySetDefaultMasterPassword(
    IN IDE_SECURITY_PROTOCOL *This,
    UINT16                   Control,
    UINT8                    *Buffer,
    UINT16                   RevisionCode )
{
    VOID       *BusInterface = ((SECURITY_PROTOCOL* )This)->BusInterface;
    BOOLEAN    ModeFlag      = ((SECURITY_PROTOCOL* )This)->ModeFlag;
    EFI_STATUS Status;

    #if (!DISABLE_SOFT_SET_PREV && !FORCE_HDD_PASSWORD_PROMPT ) || HDD_PASSWORD_ON_NVRAM
    UINT32     HddDataId  = 0;
    UINT16     UserMaster = 0;
    #endif

    Control &= 0x0101;          // Bit0 and Bit 8 are valid

    //
    // Update the Identify device buffer
    //
    UpdateIdentifyData( BusInterface, ModeFlag );

    Status = SecurityCommonRoutine(
        BusInterface,
        Control,
        Buffer,
        SECURITY_SET_PASSWORD,
        RevisionCode,
        ModeFlag
        );

    //
    // Update the Identify device buffer
    //
    UpdateIdentifyData( BusInterface, ModeFlag );

    //
    // If Password is set successfully, save it.
    //
    if ( !EFI_ERROR( Status ))
    {
        SmmHDDPasswordInterface(
            This,
            Control,
            Buffer,
            SW_SMI_HDD_PASSWORD_SAVE
            );

        #if (!DISABLE_SOFT_SET_PREV && !FORCE_HDD_PASSWORD_PROMPT ) || HDD_PASSWORD_ON_NVRAM
        Status = GatherIdeInfo( BusInterface, ModeFlag, &HddDataId );
        ASSERT_EFI_ERROR( Status );

        Status = SetHddSecDataInNvram( BusInterface,
                                       &HddDataId,
                                       Control,
                                       Buffer );
        ASSERT_EFI_ERROR( Status );
        #endif
    }

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   SecurityFreezeLock
//
// Description: Prevents any further alteration of security status on the
//              device leaving the hard disk in Frozen mode. Frozen mode is
//              disabled by power-off or hardware reset. SECURITY_FREEZE_LOCK
//              (Command Code : 0xF5)security command is used to freeze hard disk.
//
// Input:
//      IN IDE_SECURITY_PROTOCOL        *This,
//
// Output:
//      EFI_SUCCESS : Hard disk is successdully kept in FROZEN state.
//      EFI_ERROR   : Security Freeze command failed.
//
// Notes:
//  Commands disabled by SECURITY FREEZE LOCK are:
//      - SECURITY SET PASSWORD
//      - SECURITY UNLOCK
//      - SECURITY DISABLE PASSWORD
//      - SECURITY ERASE PREPARE
//      - SECURITY ERASE UNIT
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS SecurityFreezeLock(
    IN IDE_SECURITY_PROTOCOL *This )
{
    EFI_STATUS            Status;
    VOID                  *BusInterface
        = ((SECURITY_PROTOCOL* )This)->BusInterface;
    BOOLEAN               ModeFlag
        = ((SECURITY_PROTOCOL* )This)->ModeFlag;
    UINT16                SecurityStatus = 0;

    COMMAND_STRUCTURE     CommandStructure;
#if !DISABLE_SOFT_SET_PREV && !FORCE_HDD_PASSWORD_PROMPT
    IDENTIFY_DATA         IdentifyData;
#endif
   
    Status=ReturnSecurityStatus( This, &SecurityStatus );
    if(EFI_ERROR(Status)) {
        return Status;
    }

    // Freeze Lock command will not work with the HDD is in Locked State.
    // So return with success if the HDD is locked state or already frozen state 
    if ( SecurityStatus & 0xc ) {
        return EFI_SUCCESS;
    }
    
    ZeroMemory( &CommandStructure, sizeof(COMMAND_STRUCTURE));
    CommandStructure.Command = SECURITY_FREEZE_LOCK;

#if !DISABLE_SOFT_SET_PREV && !FORCE_HDD_PASSWORD_PROMPT
    if ( ModeFlag == FALSE ) {
        IdentifyData = ((IDE_BUS_PROTOCOL*)BusInterface)->IdeDevice.IdentifyData;
    } else {
        IdentifyData = ((SATA_DEVICE_INTERFACE*)BusInterface)->IdentifyData;
    }
    if ( SecurityStatus & 2 )
    {
        if ( IdentifyData.Reserved_76_79[3] & 0x0040 )
        {
            Status = TransferPwDataFromNvramToSmram( This );
            ASSERT_EFI_ERROR( Status );
        }
    }
#endif

    Status =  CommonNonDataHook( BusInterface,
                                    CommandStructure,
                                     ModeFlag );
    ASSERT_EFI_ERROR (Status);
    CommandStructure.Features = DEV_CONFIG_FREEZE_LOCK_FEATURES;
    CommandStructure.Command  = DEV_CONFIG_FREEZE_LOCK;
    Status                    = CommonNonDataHook( BusInterface,
                                                   CommandStructure,
                                                   ModeFlag );

    //
    //	Update the Identify device buffer
    //
    UpdateIdentifyData( BusInterface, ModeFlag );

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   SecurityEraseUnit
//
// Description: Erases the Device content.SECURITY_ERASE_UNIT
//              (Command code : 0xF4) security command is used for device
//              erasing.
//
// Input:
//      IN IDE_SECURITY_PROTOCOL    *This,
//      UINT16                      Control,
//      UINT8                       *Buffer
//
//      Control :       Bit 0 : 0/1 User/Master Password
//						Bit 1 : 0/1 Normal Erase/ Enhanced Erase
//      Buffer  : Pointer to password buffer which will be used to when sending
//                SECURITY_ERASE_UNIT command.
//
// Output:
//  EFI_SUCCESS      : Successfull completion of Erase command.
//  EFI_DEVICE_ERROR : EraseUnit command failed to complete.
//
// Notes:
//  If a device is locked with USER PASSWORD and Maximum security level set
//  then only way to unlock the device with MASTER password is to erase the
//  contents of the device.
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS SecurityEraseUnit(
    IN IDE_SECURITY_PROTOCOL *This,
    UINT16                   Control,
    UINT8                    *Buffer )
{
    EFI_STATUS        Status;

    VOID              *BusInterface   \
        = ((SECURITY_PROTOCOL* )This)->BusInterface;
    BOOLEAN           ModeFlag   \
        = ((SECURITY_PROTOCOL* )This)->ModeFlag;
    COMMAND_STRUCTURE CommandStructure;

    ZeroMemory( &CommandStructure, sizeof(COMMAND_STRUCTURE));
    CommandStructure.Command = SECURITY_ERASE_PREPARE;

    Status = CommonNonDataHook( BusInterface, CommandStructure, ModeFlag );

    //
    // Issue Security Erase Unit
    //
    Control &= 0x3;             // Bit0 and Bit 1 is valid
    Status   = SecurityCommonRoutine(
        BusInterface,
        Control,
        Buffer,
        SECURITY_ERASE_UNIT,
        0,
        ModeFlag
        );

    //
    // Update the Identify device buffer
    //
    UpdateIdentifyData( BusInterface, ModeFlag );

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   ReturnIdePasswordFlags
//
// Description: Returns Ide Password Variables and Flags.
//
// Input:
//          IN IDE_SECURITY_PROTOCOL        *This,
//          UINT32                          *IdePasswordFlags
//
// Output:
//  EFI_SUCCESS : IDEPassword Status Flag is returned in IdePasswordFlags.
//  EFI_ERROR   : Error while retrieving the SecurityStatus.
//
//
// Referrals:
//
//  IdePasswordFlags:
// **TBD Only Bit0, Bit03, Bit11, Bit16, Bit17 are Supported Currently
//
//         BIT0                             User Password Support;
//         BIT1                             Master Password Support;
//         BIT2                             Display User Password;
//         BIT3                             Display Master Password;
//         BIT4                             Display User Password Status;
//         BIT5                             Display Master Password Status;
//         BIT6                             Freeze Lock Hdds;
//         BIT7                             Single User Password;
//         BIT8                             Single Master Password;
//         BIT9                             System User Password as Hdd User Password;
//         BIT10                            System Admin Password as Hdd Master Password;
//         BIT11                            OEM Default Master Password
//         BIT12                            Prompt for User Password in Post
//         BIT13                            Prompt for Master Password in Post
//         BIT14                            Display Security Status in Setup
//         BIT15                            DUMMY Security Token.
//         BIT16                            MasterPassword Set Status.
//         BIT17                            UserPassword Set Status.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS ReturnIdePasswordFlags(
    IN IDE_SECURITY_PROTOCOL *This,
    UINT32                   *IdePasswordFlags )
{
    EFI_STATUS            Status         = EFI_SUCCESS;
    UINT32                Temp           = 0;
    UINT16                MasterPwdRev   = 0;
    UINT16                SecurityStatus = 0;
    VOID                  *BusInterface
        = ((SECURITY_PROTOCOL* )This)->BusInterface;
    BOOLEAN               ModeFlag
        = ((SECURITY_PROTOCOL* )This)->ModeFlag;
    IDENTIFY_DATA         IdentifyData;
    IDE_BUS_PROTOCOL      *IdeBusInterface;
    SATA_DEVICE_INTERFACE *SataDevInterface;

    IdeBusInterface  = (IDE_BUS_PROTOCOL*)BusInterface;
    SataDevInterface = (SATA_DEVICE_INTERFACE*)BusInterface;

    if ( ModeFlag == FALSE )
    {
        IdentifyData = IdeBusInterface->IdeDevice.IdentifyData;
    }
    else {
        IdentifyData = SataDevInterface->IdentifyData;
    }



    #if MASTER_PASSWORD_ENABLE
    Temp |= BIT01;
    #endif


    #if DISPLAY_MASTER_PASSWORD
    Temp |= BIT03;
    #endif

    #if OEM_DEFAULT_MASTER_PASSWORD
    Temp |= BIT11;
    #endif


    MasterPwdRev = IdentifyData.Master_Password_Rev_92;

    if ((MasterPwdRev != 0x0000) && (MasterPwdRev != 0xFFFF)    \
        && (MasterPwdRev != DISABLED_MASTER_PASSWORD_REVISION))
    {
        Temp |= BIT16;
    }

    Status = ReturnSecurityStatus( This, &SecurityStatus );

    if ( EFI_ERROR( Status ))
    {
        return Status;
    }

    if ( SecurityStatus & BIT01 )
    {
        Temp |= BIT17;
    }

    *IdePasswordFlags = (UINT32)Temp;
    return EFI_SUCCESS;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:	SecurityCommonRoutine
//
// Description:	This is common security routine which will be called from
//              security routines. It is from this routine most of the security
//              commands are sent to the drive.
//
// Input:
//      IN VOID                         *BusInterface,
//      UINT16                          Control,
//      UINT8                           *Buffer (32 Bytes),
//      UINT8                           SecurityCommand
//      UINT8                           RevisionCode
//                                      (Valid for Master password)
//
//  Control : Bit 0 : 0/1 User/Master Password
//            Bit 1 : 0/1 Normal/Enhanced Erase
//            Bit 8 : 0/1 High/Maximum Security level
//
//  Buffer  : Pointer to password buffer which will be used to when sending
//            SecurityCommand.
//
//
// Output:
//  EFI_STATUS : EFI_SUCCESS/EFI_DEVICE_ERROR
//
// Notes:
//  1. Buffer should be 32 bytes long (Mandatory). Even if Password is not
//     32 bytes long, pad it with zeros to create a buffer of 32 bytes.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS SecurityCommonRoutine(
    IN VOID *BusInterface,
    UINT16  Control,
    UINT8   *Buffer,
    UINT8   SecurityCommand,
    UINT16  RevisionCode,
    BOOLEAN ModeFlag )
{
    EFI_STATUS Status;
    UINT16     *SecurityBuffer;

    //
    // Allocate 512 Bytes
    //
    Status = pBS->AllocatePool( EfiBootServicesData,
                                SECURITY_BUFFER_LENGTH,
                                (VOID**)&SecurityBuffer );

    if ( EFI_ERROR( Status ))
    {
        return Status;
    }

    //
    // Clear the Buffer
    //
    ZeroMemory( SecurityBuffer, SECURITY_BUFFER_LENGTH );

    SecurityBuffer[0] = Control;

    //
    // Copy 32 Bytes
    //
    pBS->CopyMem( &(SecurityBuffer[1]), Buffer, IDE_PASSWORD_LENGTH );

    //
    // If Security Set password command is for Master, then update the
    // revision code.
    //
    if ((SecurityCommand == SECURITY_SET_PASSWORD) & (Control & 1))
    {
        if ((RevisionCode != 0) || (RevisionCode != 0xFFFF))
        {
            SecurityBuffer[17] = RevisionCode;
        }
    }

    //
    // Write 512 Bytes
    //
    Status = CommonReadWritePioHook(
        BusInterface,
        SecurityBuffer,
        SECURITY_BUFFER_LENGTH,
        0,
        SecurityCommand,
        TRUE,
        ModeFlag
        );

    pBS->FreePool( SecurityBuffer );
    return Status;
}


//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   SmmHDDPasswordInterface
//
// Description: Manages HDD Password in SMM area.
//
// Input:
//          IN IDE_SECURITY_PROTOCOL    *This,
//          UINT16                      Control,
//          UINT8                       *Buffer
//          UINT8                       Action
//
//
//  Control : Bit 0 : 0/1 User/Master Password
//
//  Buffer  : Pointer to password buffer which will be used to when sending
//            SecurityCommand.
//
// Output:
// EFI_SUCCESS      : Password saved which will be used to unlock the drive
//                    during S3 resume.
// EFI_DEVICE_ERROR : Error in saving Password.
//
// Notes:
//  1. Buffer should be 32 bytes long (Mandatory). Even if Password is not
//     32 bytes long, pad it with zeros to create a buffer of 32 bytes.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS SmmHDDPasswordInterface(
    IN IDE_SECURITY_PROTOCOL *This,
    UINT16                   Control,
    UINT8                    *Buffer,
    UINT8                    Action )
{
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)
    UINT8               DataSize = 1;
#else
    UINTN               DataSize = 1;
#endif
    UINT8                 SwSmiValue = Action;
    UINTN                 i;
    HDD_PASSWORD          *HDDPasswordBuffer = gHDDPasswordBuffer;
    VOID                  *BusInterface   \
        = ((SECURITY_PROTOCOL* )This)->BusInterface;
    BOOLEAN               ModeFlag   \
        = ((SECURITY_PROTOCOL* )This)->ModeFlag;
    EFI_PCI_IO_PROTOCOL *PciIo;
    UINTN   SegNum;
    UINTN   BusNum;
    UINTN   DevNum;
    UINTN   FuncNum;
    EFI_STATUS  Status;

#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x00010014)
    EFI_SMM_COMMUNICATE_HEADER       *SmmCommunicationHeader;
    UINT8                            CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(HDD_PASSWORD)];
    UINTN                            CommBufferSize;
#endif

    IDE_BUS_PROTOCOL      *IdeBusInterface;
    SATA_DEVICE_INTERFACE *SataDevInterface;

    IdeBusInterface  = (IDE_BUS_PROTOCOL*)BusInterface;
    SataDevInterface = (SATA_DEVICE_INTERFACE*)BusInterface;

    if ( ModeFlag == FALSE )
    {
        //
        //  If HDD is not going to lose power in S3, no need to unlock password and put it in
        //  Freeze state during S3 resume.
        //
        if ( !(IdeBusInterface->IdeBusInitInterface->Flags   \
               & S3_RESUME_UNLOCK_HDD_PASSWORD))
        {
            return EFI_SUCCESS;
        }

        HDDPasswordBuffer->BaseAddress
            = IdeBusInterface->IdeDevice.Regs.CommandBlock.DataReg;
        HDDPasswordBuffer->Device = IdeBusInterface->IdeDevice.Device;
        HDDPasswordBuffer->DeviceControlReg
            = IdeBusInterface->IdeDevice.Regs.ControlBlock.DeviceControlReg;
        PciIo = IdeBusInterface->PciIO;

    }
    else {

        PciIo=SataDevInterface->AhciBusInterface->PciIO;
        HDDPasswordBuffer->PortNumber   = SataDevInterface->PortNumber;
        HDDPasswordBuffer->PMPortNumber = SataDevInterface->PMPortNumber;
    }

    //
    // Get PCI Bus/Device/Function number
    //
    Status = PciIo->GetLocation (   PciIo,
                                    &SegNum,
                                    &BusNum,
                                    &DevNum,
                                    &FuncNum
                                     );

    //
    // Save it for IdeSmm to initilize the controller.
    //
    HDDPasswordBuffer->BusNo=(UINT8)BusNum;
    HDDPasswordBuffer->DeviceNo=(UINT8)DevNum;
    HDDPasswordBuffer->FunctionNo=(UINT8)FuncNum;

    HDDPasswordBuffer->Signature = '$HDD'; // 0x44444824; //
    HDDPasswordBuffer->Control   = Control;
    HDDPasswordBuffer->ModeFlag  = ModeFlag;

    //
    //      HDDPasswordBuffer->RevisionCode = RevisionCode;
    //
    if ( Control & 0x01 )
    {
        for ( i = 0; i < sizeof (HDDPasswordBuffer->MasterPassword); i++ )
        {
            HDDPasswordBuffer->MasterPassword[i] = Buffer[i];
        } // end of for
    }
    else {
        for ( i = 0; i < sizeof (HDDPasswordBuffer->UserPassword); i++ )
        {
            HDDPasswordBuffer->UserPassword[i] = Buffer[i];
        } // end of for
    }

#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x00010014)

    if(!gSmmCommunication) {
        Status = pBS->LocateProtocol (
                        &gEfiSmmCommunicationProtocolGuid,
                        NULL,
                        (VOID **)&gSmmCommunication
                        );
        if (EFI_ERROR (Status)) {
            ASSERT_EFI_ERROR (Status);
            return Status;
        }
    }

    SmmCommunicationHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];

    if(SwSmiValue == SW_SMI_HDD_PASSWORD_SAVE) {
        pBS->CopyMem( &SmmCommunicationHeader->HeaderGuid, &gSaveHddPasswordGuid, sizeof( EFI_GUID ) );
    } else if( SwSmiValue == SW_SMI_HDD_PASSWORD_REMOVE ) {
        pBS->CopyMem( &SmmCommunicationHeader->HeaderGuid, &gRemoveHddPasswordGuid, sizeof( EFI_GUID ) );
    } else {
        // Unknown SwSmiValue
        return EFI_UNSUPPORTED;
    }
    
    SmmCommunicationHeader->MessageLength  = sizeof(HDD_PASSWORD);
    pBS->CopyMem( &SmmCommunicationHeader->Data, HDDPasswordBuffer, sizeof(HDD_PASSWORD) );

    CommBufferSize = sizeof(CommBuffer);
    Status = gSmmCommunication->Communicate (gSmmCommunication, &CommBuffer[0], &CommBufferSize);
#else
    //  Now Generate a SW SMI to log this data
    mSmmCtl->Trigger( mSmmCtl, &SwSmiValue, &DataSize, 0, 0 );
#endif

    return EFI_SUCCESS;
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure:   UpdateIdentifyData
//
// Description: Updates Identify command data.IDENTIFY_DATA(Command Code: 0xEC)
//              command used to update the Identifydata buffer.
//
// Input:
//  IN IDE_BUS_PROTOCOL             *IdeBusInterface,
//  IN BOOLEAN                      ModeFlag
//
// Output:
//      EFI_SUCCESS : Identifydata updated successfully.
//      EFI_ERROR   : Failed to update the identifydata.
//
// Notes:   ATA/ATAPI device type should have beeen known already.
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS UpdateIdentifyData(
    IN IDE_BUS_PROTOCOL *BusInterface,
    IN BOOLEAN          ModeFlag )
{
    EFI_STATUS        Status;
    COMMAND_STRUCTURE CommandStructure;

    ZeroMemory( &CommandStructure, sizeof(COMMAND_STRUCTURE));

    CommandStructure.ByteCount = sizeof(IDENTIFY_DATA);
    CommandStructure.Command   = IDENTIFY_COMMAND;

    Status = CommonPioDataHook( BusInterface, CommandStructure, ModeFlag );

    return Status;
}

#if MASTER_PASSWORD_ENABLE
//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   OEMSetMasterPassword
//
// Description: Sets the Default Password String provided by OEM as
//              Master Password. SECURITY_SET_PASSWORD(Command Code : 0xF1)
//              security command is used to set the master password.
// Input:
//          IN IDE_SECURITY_PROTOCOL        *This,
//
// Output:
//      EFI_SUCCESS : OEM Master password set successfully.
//      EFI_ERROR   : Failed to set OEM Master passord to the hard disk.
//
// Notes:
//  OEM_MASTER_PASSWORD_TAG token string will be set as oem master password.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS OEMSetMasterPassword(
    IN IDE_SECURITY_PROTOCOL *This )
{
    EFI_STATUS Status = 0;
    UINT8      Buffer[IDE_PASSWORD_LENGTH];
    UINT16     Control      = 1;
    UINT16     RevisionCode = 0xFFFE;
    UINTN      i;
    UINT16     SecurityStatus = 0;

    MemSet( &Buffer, IDE_PASSWORD_LENGTH, 0 );

    for ( i = 0; i < IDE_PASSWORD_LENGTH; i++ )
    {
        Buffer[i] = (UINT8)sOemMasterPasswordTag[i];

#if defined SETUP_PASSWORD_NON_CASE_SENSITIVE && SETUP_PASSWORD_NON_CASE_SENSITIVE 
        Buffer[i] = ((Buffer[i]>='a')&&(Buffer[i]<='z'))?(Buffer[i]+'A'-'a'):Buffer[i];
#endif
        if ( sOemMasterPasswordTag[i] == L'\0' )
        {
            break;
        }
    }

    //
    //Set the OEM master password if the HDD is not in Frozen or locked state.
    //
    ReturnSecurityStatus( This, &SecurityStatus );

    if ( !((SecurityStatus & 0x04) || (SecurityStatus & 0x08)))
    {
        Status = SecuritySetPassword( This, Control, Buffer, RevisionCode );
    }

    return Status;
}

#endif

#if (!DISABLE_SOFT_SET_PREV && !FORCE_HDD_PASSWORD_PROMPT ) || HDD_PASSWORD_ON_NVRAM
//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   GatherIdeInfo
//
// Description:	Gathers Ide Device's Bus,Func,Device & PM/PS/SM/SS Info.
//
// Input:
//          IN VOID                     *BusInterface,
//          OUT UINT32                  *HddDataId
//
// Output:
//      EFI_SUCCESS : IDE info retrieved successfully.
//      EFI_ERROR   : Failed to get IDE info.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS GatherIdeInfo(
    IN VOID    *BusInterface,
    BOOLEAN    ModeFlag,
    OUT UINT32 *HddDataId )
{
    EFI_STATUS            Status;
    UINTN                 SegNum;
    UINTN                 BusNum;
    UINTN                 DevNum;
    UINTN                 FuncNum;
    UINT16                wBDF;
    UINT16                wPortPMModeFlag;
    UINT8                 ChannelorPort;
    UINT8                 DeviceorPMPort;
    EFI_PCI_IO_PROTOCOL   *PciIo;
    IDE_BUS_PROTOCOL      *IdeBusInterface;
    SATA_DEVICE_INTERFACE *SataDevInterface;

    IdeBusInterface  = (IDE_BUS_PROTOCOL*)BusInterface;
    SataDevInterface = (SATA_DEVICE_INTERFACE*)BusInterface;

    if ( ModeFlag == FALSE )
    {
        PciIo          = IdeBusInterface->PciIO;
        ChannelorPort  = IdeBusInterface->IdeDevice.Channel;
        DeviceorPMPort =  IdeBusInterface->IdeDevice.Device;
    }
    else {
        PciIo          = SataDevInterface->AhciBusInterface->PciIO;
        ChannelorPort  = SataDevInterface->PortNumber;
        DeviceorPMPort =  SataDevInterface->PMPortNumber;
    }

    Status = PciIo->GetLocation( PciIo, &SegNum, &BusNum, &DevNum, &FuncNum );

    wBDF            = (UINT16)((BusNum << 8) | (DevNum << 3) | FuncNum );
    wPortPMModeFlag = (UINT16)((ChannelorPort << 12)   \
                               | (DeviceorPMPort << 4)   \
                               | ((UINT8)ModeFlag));

    *HddDataId = (UINT32)(((UINT16)wBDF << 16) + ((UINT16)wPortPMModeFlag));

    return EFI_SUCCESS;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   SetHddSecDataInNvram
//
// Description: Sets Hdd Security Data in NVRAM Area.
//
// Input:
//          IN VOID                     *BusInterface,
//          UINT32                      *HddDataId
//          UINT16                      Control,
//          UINT8                       *Buffer
//
//  Control : Bit 0 : 0/1 User/Master Password
//
//  Buffer  : Pointer to password buffer which will be used to when sending
//            SecurityCommand.
// Output:
//  EFI_SUCCESS : HDDPassword saved in NVram which later will be transfered to
//                SMRAM.
//  EFI_ERROR   : Failed to save the HDD password in nvram.
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS SetHddSecDataInNvram(
    IN VOID *BusInterface,
    UINT32  *HddDataId,
    UINT16  Control,
    UINT8   *Buffer )
{
    EFI_STATUS Status;
    HDDSECDATA *HddSecData=NULL;
    UINTN      i;
    CHAR16     *HddSecutiyData = NULL;
    UINT8      CryptBuffer[IDE_PASSWORD_LENGTH];
    UINTN      HddSecDataSize = sizeof (HDDSECDATA);
    UINT32     ParseIndex;
    UINT32     Attribute = 0;

    pBS->AllocatePool( EfiBootServicesData, sizeof (HDDSECDATA), &HddSecData );
    pBS->SetMem( HddSecData, sizeof(HDDSECDATA), 0 );
    pBS->AllocatePool( EfiBootServicesData,
                       IDE_PASSWORD_LENGTH,
                       &HddSecutiyData );
    pBS->SetMem( HddSecutiyData, IDE_PASSWORD_LENGTH, 0 );
    ConvertHddDataIdToString( *HddDataId, HddSecutiyData );

    //
    // Get the password variable so that other password will be
    // maintained in the nvram variable.
    //
    Status = pRS->GetVariable(
        HddSecutiyData,
        &gIdeSecurityPwNvguid,
        &Attribute,
        &HddSecDataSize,
        HddSecData
        );

    if ( EFI_ERROR( Status ))
    {
        pBS->SetMem( HddSecData, sizeof(HDDSECDATA), 0 );
        if(Attribute == 0) {
            Attribute = (UINT32)(EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS);
        }
    }


    for ( ParseIndex = 0; ParseIndex < IDE_PASSWORD_LENGTH; ParseIndex++ )
    {
        if ( Buffer[ParseIndex] == 0 )
        {
            break;
        }
    }

    HddSecData->UserMaster     = Control;
    HddSecData->PasswordLength = ParseIndex;

    if ( Control & 0x01 )
    {
        EncodeDecodePassword( Buffer, CryptBuffer, ParseIndex );

        for ( i = 0; i < ParseIndex; i++ )
        {
            HddSecData->HddMasterPassword[i] = CryptBuffer[i];
        }

        for ( i = ParseIndex; i < sizeof (HddSecData->HddMasterPassword); i++ )
        {
            HddSecData->HddMasterPassword[i] = 00;
        }
    }
    else {
        EncodeDecodePassword( Buffer, CryptBuffer, ParseIndex );

        for ( i = 0; i < ParseIndex; i++ )
        {
            HddSecData->HddUserPassword[i] = CryptBuffer[i];
        }

        for ( i = ParseIndex; i < sizeof (HddSecData->HddUserPassword); i++ )
        {
            HddSecData->HddUserPassword[i] = 00;
        }
    }

    Status = pRS->SetVariable(
        HddSecutiyData,
        &gIdeSecurityPwNvguid,
        Attribute,
        HddSecDataSize,
        HddSecData
        );

    ASSERT_EFI_ERROR( Status );
    pBS->FreePool( HddSecData );

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   TransferPwDataFromNvramToSmram
//
// Description: Transfers Stored Data from NVRAM to SMRAM.
//
// Input:
//          IN IDE_SECURITY_PROTOCOL    *This,
//
// Output:
//  EFI_SUCCESS      : Password saved in SMRAM.
//  EFI_DEVICE_ERROR : Password not saved in SMRAM.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS TransferPwDataFromNvramToSmram(
    IN IDE_SECURITY_PROTOCOL *This 
)
{
    UINT32      HddDataId       = 0;
    UINT16      UserMaster      = 0;
    CHAR16      *HddSecutiyData = NULL;
    HDDSECDATA   *HddSecData = NULL;
    VOID         *BusInterface   \
        = ((SECURITY_PROTOCOL* )This)->BusInterface;
    BOOLEAN      ModeFlag = ((SECURITY_PROTOCOL* )This)->ModeFlag;
    EFI_STATUS  Status;
    UINT16      Control;
    UINTN       i;
    UINTN       HddSecDataSize = sizeof (HDDSECDATA);
    UINT8       CryptBuffer[IDE_PASSWORD_LENGTH];
    UINT8       Buffer[IDE_PASSWORD_LENGTH];
    UINT16      SecurityStatus = 0;
    
    Status=ReturnSecurityStatus( This, &SecurityStatus );
    
    if(EFI_ERROR(Status)) {
        return Status;
    }

    // Hdd Password Nvram Variable will not be avilable if the HDD is in locked state. 
    // So return without copying the password to Smram as the password 
    // data is not avilable
    
    if ( SecurityStatus & 4 ) {
        return EFI_SUCCESS;
    }

    Status = GatherIdeInfo( BusInterface, ModeFlag, &HddDataId );
    ASSERT_EFI_ERROR( Status );

    pBS->AllocatePool( EfiBootServicesData,
                       IDE_PASSWORD_LENGTH,
                       &HddSecutiyData );
    pBS->SetMem( HddSecutiyData, IDE_PASSWORD_LENGTH, 0 );
    ConvertHddDataIdToString( HddDataId, HddSecutiyData );

    pBS->AllocatePool( EfiBootServicesData, sizeof (HDDSECDATA), &HddSecData );
    pBS->SetMem( HddSecData, sizeof(HDDSECDATA),  0 );

    pBS->SetMem( Buffer,     IDE_PASSWORD_LENGTH, 0 );

    Status = pRS->GetVariable(
        HddSecutiyData,
        &gIdeSecurityPwNvguid,
        NULL,
        &HddSecDataSize,
        HddSecData
        );

    if(Status){
        Status = HDDPortReset(BusInterface,ModeFlag);
        return Status;
    }

    Control = HddSecData->UserMaster;

    if ( Control & 0x01 )
    {
        for ( i = 0; i < sizeof (HddSecData->HddMasterPassword); i++ )
        {
            CryptBuffer[i] = HddSecData->HddMasterPassword[i];
        }

        EncodeDecodePassword( CryptBuffer, Buffer, HddSecData->PasswordLength );
    }
    else {
        for ( i = 0; i < sizeof (HddSecData->HddUserPassword); i++ )
        {
            CryptBuffer[i] = HddSecData->HddUserPassword[i];
        }

        EncodeDecodePassword( CryptBuffer, Buffer, HddSecData->PasswordLength );
    }

        SmmHDDPasswordInterface( This,
                             Control,
                             Buffer,
                             SW_SMI_HDD_PASSWORD_SAVE );

    pBS->FreePool( HddSecData );

    return Status;
}


//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   ConvertHddDataIdToString
//
// Description: Converts Integer HDD Data Id to String.
//
// Input:
//           IN  UINT32          DataId,
//           OUT CHAR16          *String
// Output:
//	        None
//
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
VOID ConvertHddDataIdToString(
    IN UINT32  DataId,
    OUT CHAR16 *String )
{
    Swprintf( String, L"%*d", 0, DataId );
    return;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:	EncodeDecodePassword
//
// Description:	Encodes/Decodes Password.
//
// Input:
//           IN   UINT8        *InputString,
//           OUT  UINT8        *OutputString,
//           IN   UINT32       StringLen
// Output:
//          None
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
VOID EncodeDecodePassword(
    IN UINT8  *InputString,
    OUT UINT8 *OutputString,
    IN UINT32 StringLength )
{
    UINT8  *Key;
    UINT32 i;
    UINT32 KeyIndex;
    UINT32 KeyLength;

    if ((InputString == NULL) || (StringLength == 0))
    {
        return;
    }

    KeyLength = (UINT32)( Strlen( HDD_PWD_ENCRYPTION_KEY ));
    pBS->AllocatePool( EfiBootServicesData, KeyLength, (VOID**)&Key );
    pBS->SetMem( Key, KeyLength, 0 );
    pBS->CopyMem( Key, HDD_PWD_ENCRYPTION_KEY, KeyLength );
    ASSERT( Key != NULL );

    for ( i = 0, KeyIndex = 0; i < StringLength; i++, KeyIndex++ )
    {
        if ( KeyIndex == (KeyLength - 1))
        {
            KeyIndex = 0;
        }
        OutputString[i] = (UINT8) ( InputString[i] ^ Key[KeyIndex] );
    }

    pBS->FreePool( Key );
    return;
}
  
#endif


//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   CommonNonDataHook
//
// Description: Common Hook which Calls Non Data Command.
//
// Input:       IN    VOID*                 BusInterface,
//              IN    COMMAND_STRUCTURE     CommandStructure,
//              IN    BOOLEAN               ModeFlag
//
// Output:
//  EFI_SUCCESS                      : Non Data command completed successfully.
//  EFI_DEVICE_ERROR/EFI_UNSUPPORTED : Not supported.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS CommonNonDataHook(
    IN VOID              *BusInterface,
    IN COMMAND_STRUCTURE CommandStructure,
    IN BOOLEAN           ModeFlag )
{
    EFI_STATUS            Status;
    IDE_BUS_PROTOCOL      *IdeBusInterface;
    SATA_DEVICE_INTERFACE *SataDevInterface;

    IdeBusInterface  = (IDE_BUS_PROTOCOL*)BusInterface;
    SataDevInterface = (SATA_DEVICE_INTERFACE*)BusInterface;

    if ( ModeFlag == FALSE )
    {
        CommandStructure.Device = IdeBusInterface->IdeDevice.Device << 4;

        //
        // Idebus API changed from Core 4.6.5.2. Added Core Version check for the OLD 
        // Core support.
        //
#if defined CORE_COMBINED_VERSION && (CORE_COMBINED_VERSION > 0x4028b) 
        Status = IdeBusInterface->IdeNonDataCommand(
            IdeBusInterface,
            CommandStructure.Features,
            (UINT8)CommandStructure.SectorCount,
            (UINT8)(CommandStructure.SectorCount >> 8),
            CommandStructure.LBALow,
            CommandStructure.LBALowExp,
            CommandStructure.LBAMid,
            CommandStructure.LBAMidExp,
            CommandStructure.LBAHigh,
            CommandStructure.LBAHighExp,
            CommandStructure.Device,
            CommandStructure.Command
            );
#else 
        Status = IdeBusInterface->IdeNonDataCommand(
            IdeBusInterface,
            CommandStructure.Features,
            (UINT8)CommandStructure.SectorCount,
            CommandStructure.LBALow,
            CommandStructure.LBAMid,
            CommandStructure.LBAHigh,
            CommandStructure.Device,
            CommandStructure.Command
            );

#endif
    }
    else {
        Status = SataDevInterface->AhciBusInterface->ExecuteNonDataCommand(
            SataDevInterface,
            CommandStructure
            );
    }

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   CommonPioDataHook
//
// Description: Common Hook which Calls Pio Data Command.
//
// Input:       IN    VOID*                 BusInterface,
//              IN    COMMAND_STRUCTURE     CommandStructure,
//              IN    BOOLEAN               ModeFlag
//
// Output:
//  EFI_SUCCESS                      : Pio data command completed.
//  EFI_DEVICE_ERROR/EFI_UNSUPPORTED : Not supported.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS CommonPioDataHook(
    IN VOID              *BusInterface,
    IN COMMAND_STRUCTURE CommandStructure,
    IN BOOLEAN           ModeFlag )
{
    EFI_STATUS            Status;
    IDE_BUS_PROTOCOL      *IdeBusInterface;
    SATA_DEVICE_INTERFACE *SataDevInterface;
    VOID                  *IdentifyBuffer = NULL;

    IdeBusInterface  = (IDE_BUS_PROTOCOL*)BusInterface;
    SataDevInterface = (SATA_DEVICE_INTERFACE*)BusInterface;

    Status = pBS->AllocatePool( EfiBootServicesData,
                                sizeof(IDENTIFY_DATA),
                                (VOID**)&IdentifyBuffer
                                );
    //
    //  Read Identifydata
    //
    CommandStructure.Buffer = IdentifyBuffer;

    if ( ModeFlag == FALSE )
    {
        CommandStructure.Device = IdeBusInterface->IdeDevice.Device << 4;
        Status                  = IdeBusInterface->AtaPioDataIn(
            IdeBusInterface,
            CommandStructure
                .Buffer,
            CommandStructure
                .ByteCount,
            CommandStructure
                .Features,
            (UINT8)
            CommandStructure.SectorCount,
            CommandStructure
                .LBALow,
            CommandStructure
                .LBAMid,
            CommandStructure
                .LBAHigh,
            CommandStructure
                .Device,
            CommandStructure
                .Command,
            FALSE
            );
        //
        // Copy Identify Data
        //
        pBS->CopyMem( &(IdeBusInterface->IdeDevice.IdentifyData),
                      IdentifyBuffer,
                      sizeof(IDENTIFY_DATA)
                      );
    }
    else {
        Status = SataDevInterface->AhciBusInterface->ExecutePioDataCommand(
            SataDevInterface,
            &CommandStructure,
            FALSE
            );

        //
        // Copy Identify Data
        //
        pBS->CopyMem( &(SataDevInterface->IdentifyData),
                      IdentifyBuffer,
                      sizeof(IDENTIFY_DATA)
                      );
    }

    pBS->FreePool( IdentifyBuffer );

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
//
// Procedure:   CommonReadWritePioHook
//
// Description: Common Hook which Calls Read Write PIO.
//
// Input:
//  IN VOID                         *BusInterface,
//  VOID                            *Buffer,
//  UINTN                           ByteCount,
//  UINT64                          LBA
//  IN UINT8                        ReadWriteCommand,
//  IN BOOLEAN                      ReadWrite        Read/Write = 0/1
//  IN BOOLEAN                      ModeFlag
//
// Output:
//      *Buffer updated from PIO command.
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS CommonReadWritePioHook(
    IN VOID     *BusInterface,
    IN OUT VOID *Buffer,
    IN UINTN    ByteCount,
    IN UINT64   LBA,
    IN UINT8    ReadWriteCommand,
    IN BOOLEAN  ReadWrite,
    IN BOOLEAN  ModeFlag )
{
    EFI_STATUS            Status;
    IDE_BUS_PROTOCOL      *IdeBusInterface;
    SATA_DEVICE_INTERFACE *SataDevInterface;

    IdeBusInterface  = (IDE_BUS_PROTOCOL*)BusInterface;
    SataDevInterface = (SATA_DEVICE_INTERFACE*)BusInterface;

    if ( ModeFlag == FALSE )
    {
        Status = IdeBusInterface->AtaReadWritePio(
            IdeBusInterface,
            Buffer,
            ByteCount,
            0,
            ReadWriteCommand,
            TRUE
            );
    }
    else {
        Status = SataDevInterface->AhciBusInterface->SataReadWritePio(
            SataDevInterface,
            Buffer,
            ByteCount,
            0,
            ReadWriteCommand,
            TRUE
            );
    }

    return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:   LocateAhciSmmServiceEvent
//
// Description: Generates the SwSMI to Locate the AhciSMM Protocol
//              that is used by IdeSMM.
//
// Input:
//        EFI_EVENT     Event,
//        VOID          *Context
//
// Output:
//    None
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
VOID LocateAhciSmmServiceEvent(
    EFI_EVENT Event,
    VOID      *Context )
{
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x00010014)
    EFI_SMM_COMMUNICATE_HEADER  *SmmCommunicateHeader;
    UINT8                       CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(UINT8*)];
    UINTN                       CommBufferSize;
    EFI_STATUS                  Status;
#elif defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)
    UINT8 DataSize = 1;
#else
    UINTN DataSize = 1;
#endif

#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x00010014)

    if(gSmmCommunication != NULL) {
        Status = pBS->LocateProtocol (&gEfiSmmCommunicationProtocolGuid, NULL, (VOID **) &gSmmCommunication);
        if (EFI_ERROR(Status)) {
            ASSERT_EFI_ERROR(Status);
            return ;
        }
    }

    // Copy Smm Communicate Header Here
    SmmCommunicateHeader = (EFI_SMM_COMMUNICATE_HEADER *)CommBuffer;
    pBS->CopyMem( &SmmCommunicateHeader->HeaderGuid, &gLocateIdeAhciSmmProtocolGuid, sizeof( EFI_GUID ) );
    SmmCommunicateHeader->MessageLength  = sizeof(UINT8 *);

    // Allocate the Buffer for the Passing the Password Data to 
    // Unlock command in SMM 
    Status = pBS->AllocatePool( EfiReservedMemoryType,
                                512,
                                (VOID**)&SmmCommunicateHeader->Data );

    // Calculate Size of Communication buffer
    CommBufferSize  = sizeof (CommBuffer);

    // Send data to SMM.
    Status = gSmmCommunication->Communicate (gSmmCommunication, &CommBuffer[0], &CommBufferSize);
    ASSERT_EFI_ERROR(Status);

#else
    UINT8 SwSmiValue = SW_SMI_AHCI_LOCATE_AHCI_SMM;

    // Now Generate a SW SMI to Locate all the SMM protocols used by IDESMM
    mSmmCtl->Trigger( mSmmCtl, &SwSmiValue, &DataSize, 0, 0 );
#endif

    return;
}


EFI_STATUS
HDDPortReset(
    IN VOID *BusInterface,
    IN BOOLEAN           ModeFlag
)
{

    EFI_STATUS                          Status;
    AHCI_BUS_PROTOCOL                   *AhciBusInterface;
    SATA_DEVICE_INTERFACE               *SataDeviceInterface;
    DLINK                               *dlink;
    COMMAND_STRUCTURE                   CommandStructure = {0};
    SATA_DEVICE_INTERFACE               *SataDevInterface;
    EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *Entries = NULL;


    SataDevInterface = (SATA_DEVICE_INTERFACE*)BusInterface;
    AhciBusInterface = SataDevInterface->AhciBusInterface;

    if ( ModeFlag == FALSE ) {
        return EFI_UNSUPPORTED;
    }

    // Issue Disable Software Preservation command all the Sata Devices connected.
    dlink = AhciBusInterface->SataDeviceList.pHead; 
    if (dlink){ 
        do {
            SataDeviceInterface = OUTTER(dlink, SataDeviceLink, SATA_DEVICE_INTERFACE);
            if(SataDevInterface->PortNumber == SataDeviceInterface->PortNumber &&
                SataDevInterface->PMPortNumber == SataDeviceInterface->PMPortNumber) {
 
                // Send Disable Software Preservation command.
                CommandStructure.Features = DISABLE_SATA2_SOFTPREV;
                CommandStructure.SectorCount = 6;
                CommandStructure.Command = SET_FEATURE_COMMAND;
                Status = AhciBusInterface->ExecuteNonDataCommand(SataDeviceInterface,
                                                                 CommandStructure);
                break;
            }
            dlink = dlink-> pNext;
        }while (dlink);    
     }

    // Reset the port to restore the initial State
    Status = AhciBusInterface->GeneratePortReset(
                                AhciBusInterface,
                                SataDevInterface,
                                SataDevInterface->PortNumber,
                                SataDevInterface->PMPortNumber,
                                0,
                                0
                                );


    // Disconnect the Controller Handle 
    Status = pBS->DisconnectController(
                                AhciBusInterface->ControllerHandle,
                                NULL,
                                NULL);

    // Connect Controller handle again to invoke the HDD Password Verfication
    Status = pBS->ConnectController(
                                AhciBusInterface->ControllerHandle,
                                NULL,
                                NULL,
                                TRUE);

    // Send Enable Software Preservation command.
    CommandStructure.Features = 0x10;
    CommandStructure.SectorCount = 6;
    CommandStructure.Command = SET_FEATURE_COMMAND;
    Status = AhciBusInterface->ExecuteNonDataCommand(SataDeviceInterface,
                                                     CommandStructure);

    return Status;
}

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