summaryrefslogtreecommitdiff
path: root/Board/IO/F81866/F81866DXE.C
blob: ed434f520244194c7a09c336c6c4aaa623a4a87d (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
//*************************************************************************
//*************************************************************************
//**                                                                     **
//**        (C)Copyright 1985-2011, American Megatrends, Inc.            **
//**                                                                     **
//**                       All Rights Reserved.                          **
//**                                                                     **
//**      5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093           **
//**                                                                     **
//**                       Phone: (770)-246-8600                         **
//**                                                                     **
//*************************************************************************
//*************************************************************************
//
//*************************************************************************
// $Header: /Alaska/BIN/IO/Fintek/F81866/F81866DXE.C 3     2/03/12 2:02a Elviscai $
//
// $Revision: 3 $
//
// $Date: 2/03/12 2:02a $
//*************************************************************************
// Revision History
// ----------------
// $Log: /Alaska/BIN/IO/Fintek/F81866/F81866DXE.C $
// 
// 3     2/03/12 2:02a Elviscai
// [TAG]  		EIPNONE
// [Category]  	Bug Fix
// [Solution]  	Add WDT_INIT routine for WDT
// 
// 2     12/14/11 9:19p Kasalinyi
// [TAG]  		EIPNone
// [Category]  	Improvement
// [Description]  	Fix Smart Function build error
// [Files]  		F81866DXE.C
// F81866.UNI
// F81866.MAK
// IO_F81866.SDL
// 
// 1     7/20/11 4:22a Kasalinyi
// [Category]  	Improvement
// [Description]  	Initial Porting 
// [Files]  		F81866.CIF
// IO_F81866.SDL
// F81866.ASL
// F81866.MAK
// F81866.SD
// F81866.UNI
// F81866DXE.C
// F81866PEI.C
// F81866PeiDebugger.C
// F81866Setup.C
// F81866Setup.H
// History.txt
// F81866.chm
// 
// 4     3/21/11 9:41p Mikes
// seperate the core and oem job
// 
//*************************************************************************
//<AMI_FHDR_START>
//
// Name:  <F81866DXE.C>
//
// Description: 1. Port SIO DXE initial table and routine for genericsio.c
//              2. Define enter/exit config mode scrip table
//              3. Define SIO bootscriptable table
//
//<AMI_FHDR_END>
//*************************************************************************
//-------------------------------------------------------------------------
// Include Files
//-------------------------------------------------------------------------
#include <Efi.h>
#include <Token.h>
#include <GenericSIO.h>
#include <Setup.h>
#include <Protocol\AmiSio.h>
#include <Protocol\PciIo.h>
#include <AmiCspLib.h>
#include "BSP\DxeIoTable.h"

//-------------------------------------------------------------------------
// Constants, Macros and Type Definitions
//-------------------------------------------------------------------------
#define INITIAL_ROUTINE(name) \
static EFI_STATUS name(\
    IN    AMI_SIO_PROTOCOL     *AmiSio,\
    IN    EFI_PCI_IO_PROTOCOL  *PciIo,\
    IN    SIO_INIT_STEP        InitStep\
);

//-------------------------------------------------------------------------
//Variable, Prototype, and External Declarations
//-------------------------------------------------------------------------
EFI_BOOT_SCRIPT_SAVE_PROTOCOL * BootScriptProtocol = NULL;
#if (IODECODETYPE)
// SIO DECODE list creation code must be in this order
typedef EFI_STATUS (IO_RANGE_DECODE)(
//    IN  void            *LpcPciIo,
    IN EFI_PCI_IO_PROTOCOL      *LpcPciIo,
    IN  UINT16          DevBase, 
    IN  UINT8           UID, 
    IN  SIO_DEV_TYPE    Type
); 
extern IO_RANGE_DECODE  SIO_IoRange_Decode_LIST EndOfInitList;
static IO_RANGE_DECODE* CspIoRangeDecodeList[] = {SIO_IoRange_Decode_LIST NULL};
#endif //#if (IODECODETYPE)

extern VOID SioCfgMode(GSPIO *Sio, BOOLEAN Enter);
extern VOID DevSelect(SPIO_DEV *Dev);
extern VOID SioRegister(SPIO_DEV *Dev, BOOLEAN Write, UINT8 Reg, UINT8 *Val);

//smart fan
#if F81866_SMF_SUPPORT
extern VOID F81866SmartFunction(VOID);
#endif

EFI_STATUS LoopCspIoDecodeListInit(
    IN    EFI_PCI_IO_PROTOCOL *PciIo,
    IN    AMI_SIO_PROTOCOL    *AmiSio
);

VOID ProgramSioRegisterTable(
    IN  AMI_SIO_PROTOCOL    *AmiSio,
    IN  DXE_DEVICE_INIT_DATA *Table,
    IN  UINT8               Count
);

VOID ProgramIsaRegisterTable(
    IN  UINT16  Index,
    IN  UINT16  Data,
    IN  DXE_DEVICE_INIT_DATA *Table,
    IN  UINT8   Count
);

VOID ProgramRtRegisterTable(
    IN  UINT16  Base,
    IN  DXE_DEVICE_INIT_DATA  *Table,
    IN  UINT8   Count
);

VOID SaveSxSioRegisterTable(
    IN  UINT16  Index,
    IN  UINT16  Data,
    IN  UINT8   *Table,
    IN  UINT8   Count
);
VOID SaveSxRtRegisterTable(
    IN  UINT16  Base,
    IN  UINT16  *Table,
    IN  UINT8   Count
);
VOID ClearDevResource(
    IN    SPIO_DEV* dev
);
//Declare initial routines for your SPIO_DEV_LST list.
INITIAL_ROUTINE(FDC_Init)

INITIAL_ROUTINE(COM_Init)

INITIAL_ROUTINE(LPT_Init)

INITIAL_ROUTINE(KBC_Init)

INITIAL_ROUTINE(PME_Init)

INITIAL_ROUTINE(HWM_Init)

INITIAL_ROUTINE(GPIO_Init)

INITIAL_ROUTINE(WDT_Init)

//<AMI_THDR_START>
//-------------------------------------------------------------------------
//
// Name:        F81866_DevLst
//
// Description: Table filled with SIO porting information
//
//------------+-------+-------+--------+---------+---------+-------------+------------+------------+-----------+------------+------------+-------------|
//SIO_DEV_TYP | UINT8 | UINT8 | UINT16 | BOOLEAN | BOOLEAN | UINT8       | UINT8      | UINT16     | UINT16    | UINT16     | UINT8      | SIO_INIT    |
//Type        | LDN   | UID   | PnpId  | Impleme | HasSetu |   Flags     | AslName[5] | ResBase[2] | ResLen[2] | IrqMask[2] | DmaMask[2] | InitRoutine |
//------------+-------+-------+--------+---------+---------+-------------+------------+------------+-----------+------------+------------+-------------|
//  Field "Falgs" is needed to indicate that SIO Logical Device represented
//  by this table entry shares all or some resources with previous entry.
//  Such situation is sutable for FDC - and PS2 controller
//  This field must be filled properely in order to have driver working right.
//  Here possible Flags Settings
//  #define SIO_SHR_NONE    0x00
//  #define SIO_SHR_IO1     0x01 //device shares resources programmed in SIO_1_BASE_REG
//  #define SIO_SHR_IO2     0x02 //device shares resources programmed in SIO_2_BASE_REG    
//  #define SIO_SHR_IO      0x03 //device shares resources programmed in all SIO_BASE_REG
//  #define SIO_SHR_IRQ1    0x04
//  #define SIO_SHR_IRQ2    0x08
//  #define SIO_SHR_IRQ     0x0C
//  #define SIO_SHR_DMA1    0x10
//  #define SIO_SHR_DMA2    0x20
//  #define SIO_SHR_DMA     0x30
//  #define SIO_SHR_ALL     0x3F
//  #define SIO_NO_RES      0x80 //this bit will be set if GCD call to allocate resource succeed
//                               //at least one call must return SUCCESS if this flag
//
//-------------------------------------------------------------------------
//<AMI_THDR_END>
//AMI_TODO: Please check below notes.
//1. if device has no ASL code and has IO base register to be initialized, fill it in below table
//2. If device has no IO base register to be initialized, set flag to SIO_NO_RES
//3. if more device PnpId is 0x0C08, please check the UID of these devices.
static SPIO_DEV_LST F81866_DevLst[]={
//If device Implemented=FALSE the rest of the table will be ignored, just to avoid compilation ERROR
//Type      LDN               UID PnpId   Implement                     HasSetu  Share RES     AslName[5] Base   Length  IrqMask  DmaMask  InitRoutine
//===============================================================================
{dsFDC,   F81866_LDN_FDC,   0, 0x0604, F81866_FLOPPY_PORT_PRESENT,    TRUE,  SIO_SHR_NONE, {"FDC"},  {0, 0}, {0, 0}, {0, 0}, {0, 0}, FDC_Init},//LDN 0x00
{dsLPT,   F81866_LDN_LPT,   0, 0x0400, F81866_PARALLEL_PORT_PRESENT,  TRUE,  SIO_SHR_NONE, {"LPTE"}, {0, 0}, {0, 0}, {0, 0}, {0, 0}, LPT_Init},//LDN 0x03
{dsUART,  F81866_LDN_UART1, 0, 0x0501, F81866_SERIAL_PORT0_PRESENT,   TRUE,  SIO_SHR_NONE, {"UAR1"}, {0, 0}, {0, 0}, {0, 0}, {0, 0}, COM_Init},//LDN 0x10
{dsUART,  F81866_LDN_UART2, 1, 0x0501, F81866_SERIAL_PORT1_PRESENT,   TRUE,  SIO_SHR_NONE, {"UAR2"}, {0, 0}, {0, 0}, {0, 0}, {0, 0}, COM_Init},//LDN 0x11
{dsUART,  F81866_LDN_UART3, 2, 0x0501, F81866_SERIAL_PORT2_PRESENT,   TRUE,  SIO_SHR_NONE, {"UAR3"}, {0, 0}, {0, 0}, {0, 0}, {0, 0}, COM_Init},//LDN 0x12
{dsUART,  F81866_LDN_UART4, 3, 0x0501, F81866_SERIAL_PORT3_PRESENT,   TRUE,  SIO_SHR_IRQ1, {"UAR4"}, {0, 0}, {0, 0}, {0, 0}, {0, 0}, COM_Init},//LDN 0x13
{dsUART,  F81866_LDN_UART5, 4, 0x0501, F81866_SERIAL_PORT4_PRESENT,   TRUE,  SIO_SHR_IRQ1, {"UAR5"}, {0, 0}, {0, 0}, {0, 0}, {0, 0}, COM_Init},//LDN 0x14
{dsUART,  F81866_LDN_UART6, 5, 0x0501, F81866_SERIAL_PORT5_PRESENT,   TRUE,  SIO_SHR_IRQ1, {"UAR6"}, {0, 0}, {0, 0}, {0, 0}, {0, 0}, COM_Init},//LDN 0x15
{dsPS2CK, F81866_LDN_PS2K,  0, 0x0303, F81866_KEYBOARD_PRESENT,       FALSE, SIO_SHR_NONE, {"PS2K"}, {0, 0}, {0, 0}, {0, 0}, {0, 0}, KBC_Init},//LDN 0x05
#if F81866_MOUSE_PRESENT
{dsPS2CM, F81866_LDN_PS2M,  0, 0x0F03, F81866_MOUSE_PRESENT,          FALSE, SIO_SHR_IO,   {"PS2M"}, {0, 0}, {0, 0}, {0, 0}, {0, 0}, NULL},//LDN 0x05
#endif
{dsPME,   F81866_LDN_PME,   0, 0x0C08, F81866_PME_CONTROLLER_PRESENT,FALSE, SIO_NO_RES,   {NULL},   {0, 0}, {0, 0}, {0, 0}, {0, 0}, PME_Init},//LDN 0x0A
{dsHwMon, F81866_LDN_HWM,   1, 0x0C08, F81866_HWM_PRESENT,           FALSE, SIO_SHR_NONE, {NULL},   {IO3B, 0}, {IO3L, 0}, {0, 0}, {0, 0}, HWM_Init},//LDN 0x04
{dsGPIO,  F81866_LDN_GPIO,  2, 0x0C08, F81866_GPIO_PORT_PRESENT,     FALSE, SIO_SHR_NONE, {NULL},   {IO1B, 0}, {IO1L, 0}, {0, 0}, {0, 0}, GPIO_Init},//LDN 0x06
{dsNone,  F81866_LDN_WDT,   3, 0x0C08, F81866_WDT_PRESENT,           FALSE, SIO_SHR_NONE, {NULL},   {IO2B, 0}, {IO2L, 0}, {0, 0}, {0, 0}, WDT_Init},//LDN 0x06
//===============================================================================
};//SPIO_DEV_LST mSpioDeviceList[] END of structure Buffer
#define F81866_DEV_CNT (sizeof(F81866_DevLst)/sizeof(SPIO_DEV_LST))

// Note: below bootscript table->more registers, more post time
//-------------------------------------------------------------------------
// Define the registers to save/restore in BootScriptSave table when SIO sleep
//-------------------------------------------------------------------------
static UINT8 F81866_GLOBAL_REGS[] = {
    //AMI_TODO:
    //Global registers. For example:
    //LDN Register, Multi-fun registers and Device Specific registers
    //0x07,
    0x25,0x26,0x27,0x28,0x29,0x2A,0x2B,0x2C,0x2D
};
#define F81866_G_REG_CNT (sizeof(F81866_GLOBAL_REGS)/sizeof(UINT8))

//-------------------------------------------------------------------------
// Define the local registers for configure SIO
//-------------------------------------------------------------------------
static UINT8 F81866_LOCAL_REGS[] = {
//AMI_TODO: 
    F81866_ACTIVATE_REGISTER, //Activate Reg
    F81866_BASE1_HI_REGISTER, //IO Base Registers
    F81866_BASE1_LO_REGISTER, //IO Base Registers
    F81866_BASE2_HI_REGISTER, //IO Base Registers
    F81866_BASE2_LO_REGISTER, //IO Base Registers
    F81866_IRQ1_REGISTER,     //IRQ & DMA Select Regs
    F81866_IRQ2_REGISTER,     //IRQ & DMA Select Regs
    F81866_DMA1_REGISTER,     //IRQ & DMA Select Regs
    F81866_DMA2_REGISTER,     //IRQ & DMA Select Regs
    //Logical Device Configuration Registers(Dwevice Specific)
    0xE0,0xE1,0xE2,0xE3,0xE4,0xE5,0xE6,0xE7,0xE8,0xE9,0xEA,0xEB,0xEC,0xED,0xEE,
    0xF0,0xF1,0xF2,0xF3,0xF4,0xF5,0xF6,0xF7,0xF8,0xF9,0xFA,0xFB,0xFC,0xFD,0xFE,
};
#define F81866_L_REG_CNT (sizeof(F81866_LOCAL_REGS)/sizeof(UINT8))

//-------------------------------------------------------------------------
// Define script variable for enter config mode
//-------------------------------------------------------------------------
static SPIO_SCRIPT F81866_OPEN_CONFIG[]={
    //AMI_TODO:

    {
        1,    //BOOLEAN   IdxDat;     //1=IDX 0=DAT
        1,    //BOOLEAN   WrRd;       //1=Write 0=Read
        F81866_CONFIG_MODE_ENTER_VALUE  //UINT8     Value;      //if WrRd=0 wait for this data to come
    },{
        1,    //BOOLEAN   IdxDat;     //1=IDX 0=DAT
        1,    //BOOLEAN   WrRd;       //1=Write 0=Read
        F81866_CONFIG_MODE_ENTER_VALUE  //UINT8     Value;      //if WrRd=0 wait for this data to come
    }
};

//-------------------------------------------------------------------------
// Define script variable for exit config mode
//-------------------------------------------------------------------------
static SPIO_SCRIPT F81866_CLOSE_CONFIG[]={
    //AMI_TODO:

    {
        1,      //BOOLEAN   IdxDat; //1=IDX 0=DAT
        1,      //BOOLEAN   WrRd;   //1=Write 0=Read
        F81866_CONFIG_MODE_EXIT_VALUE    //UINT8     Value;  //if WrRd=0 wait for this data to come
    }
};

//-------------------------------------------------------------------------
// Here comes the table telling how to enter "SIO Config Mode"
//-------------------------------------------------------------------------
static SPIO_SCRIPT_LST    F81866_ENTER_CONFIG={
    cfgByteSeq,                 //Operation Type
    (sizeof(F81866_OPEN_CONFIG))/(sizeof(SPIO_SCRIPT)),
    &F81866_OPEN_CONFIG    //Instruction
}; 

//-------------------------------------------------------------------------
// Here comes the table telling how to exit "SIO Config Mode"
//-------------------------------------------------------------------------
static SPIO_SCRIPT_LST    F81866_EXIT_CONFIG={
    cfgByteSeq,                 //Operation Type
    (sizeof(F81866_CLOSE_CONFIG))/(sizeof(SPIO_SCRIPT)),
    &F81866_CLOSE_CONFIG   //Instruction
};

//-------------------------------------------------------------------------
// If Spio uses complicated way to enter and exit config mode
// use cfgRoutine as Operation Type instead
//-------------------------------------------------------------------------

//-------------------------------------------------------------------------
//     Here goes SPIO_LIST_ITEM structure for F81866
//-------------------------------------------------------------------------
// value of  -1 (0xF..F) means Do not check this parameter
#ifndef SB_BUS_NUM
#define SB_BUS_NUM    SIO_SB_BUS_NUM
#endif
#ifndef SB_DEV_NUM
#define SB_DEV_NUM    SIO_SB_DEV_NUM
#endif
#ifndef SB_FUNC_NUM
#define SB_FUNC_NUM    SIO_SB_FUNC_NUM
#endif

SPIO_LIST_ITEM F81866={
    //This Information is needed to identify right LPC bridge for the SIO
    -1,                             //UINT32    IsaVenDevId;
    -1,                             //UINT32    IsaSubVenId;
    SB_BUS_NUM,                     //UINT8     IsaBusNo;
    SB_DEV_NUM,                     //UINT8     IsaDevNo;
    SB_FUNC_NUM,                    //UINT8     IsaFuncNo;
    //This is the information Needed to access SIO Generic Registers
    //for the second SIO in the system change F81866 name to to SIO2_....
    //and so on
    F81866_CONFIG_INDEX,           //UINT16    SioIndex;
    F81866_CONFIG_DATA,            //UINT16    SioData;
    // Dev Select and Activate
    F81866_LDN_SEL_REGISTER,        //UINT8     DevSel;
    F81866_ACTIVATE_REGISTER,      //UINT8     Activate;
    F81866_ACTIVATE_VALUE,         //UINT8     ActivVal;
    F81866_DEACTIVATE_VALUE,       //UINT8     DeactVal;
    //Generic registers location
    F81866_BASE1_HI_REGISTER,      //UINT8     Base1Hi;
    F81866_BASE1_LO_REGISTER,      //UINT8     Base1Lo;
    F81866_BASE2_HI_REGISTER,      //UINT8     Base2Hi;
    F81866_BASE2_LO_REGISTER,      //UINT8     Base2Lo;
    F81866_IRQ1_REGISTER,          //UINT8     Irq1;
    F81866_IRQ2_REGISTER,          //UINT8     Irq2;
    F81866_DMA1_REGISTER,          //UINT8     Dma1;
    F81866_DMA2_REGISTER,          //UINT8     Dma2;
    //List of devices inside this SIO
    F81866_DEV_CNT,                //UINTN    DevCount;
    &F81866_DevLst[0],             //SPIO_DEV_LST    *SioDevList;
    //List of valid registers inside SIO to check if they has to be saved
    //in BOOT_SCRIPT_SAVE for S3 state Resume 
    //This is for global registers which are the same for all devices in SIO
    F81866_G_REG_CNT,              //UINTN        GlobalInclRegCount;
    &F81866_GLOBAL_REGS[0],        //UINT8        *GlobalIncludeReg;
    //This is for Local registers they are unique for each device in SIO
    F81866_L_REG_CNT,              //UINTN        LocalInclRegCount;
    &F81866_LOCAL_REGS[0],         //UINT8        *LocalIncludeReg; 
    //How To enter/exit Configuration mode if any 
    &F81866_ENTER_CONFIG,          //SPIO_SCRIPT_LST    *EnterCfgMode;
    &F81866_EXIT_CONFIG,           //SPIO_SCRIPT_LST    *ExitCfgMode;
};

// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: LoopCspIoDecodeListInit
//
// Description:
//  This function goes throught the elinked list IoRangeDecodeList
//
// Input:
//  IN  EFI_PCI_IO_PROTOCOL *PciIo - Read/Write PCI config space
//  IN  AMI_SIO_PROTOCOL *AmiSio -  contents SIO device information
//
// Output:
//  EFI_NOT_FOUND - can't find the decode routine.
//  EFI_SUCCESS - decode sucessfully.
//
// Modified: Nothing
//
// Referrals: None
//
// Notes:
//
//-------------------------------------------------------------------------
// <AMI_PHDR_END> 
EFI_STATUS LoopCspIoDecodeListInit(
    IN    EFI_PCI_IO_PROTOCOL *PciIo,
    IN    AMI_SIO_PROTOCOL    *AmiSio    )
{
    EFI_STATUS Status;
    SPIO_DEV    *dev=(SPIO_DEV*)AmiSio;
    #if(IODECODETYPE)  
    UINTN i;

    for(i=0; CspIoRangeDecodeList[i]; i++)
    {
        Status = CspIoRangeDecodeList[i](PciIo,dev->VlData.DevBase1, dev->DeviceInfo->UID, dev->DeviceInfo->Type);
        if(Status == EFI_SUCCESS) return Status;
    }
    #else
    Status = SbLib_SetLpcDeviceDecoding(PciIo,dev->VlData.DevBase1, dev->DeviceInfo->UID, dev->DeviceInfo->Type);
    #endif

    return Status;
}
//-------------------------------------------------------------------------

//-------------------------------------------------------------------------
//!!!!!!!!!!! PORTING REQUIRED !!!!!!!!!!! PORTING REQUIRED !!!!!!!!!!!*
//!!!!!!!!!!!!!!!! must be maintained for SIO devices!!!!!!!!!!!!!!!!!!*
//-------------------------------------------------------------------------
// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: XXXX_Init
//
// Description:
//  Each of INIT functions will be called twice by GenericSIO after standart 
//  initialization(Assigning and Programming IO/IRQ/DMA resources),
//  First time it will be called before Activating the device,
//  If device requires some additional initialization like
//      - programming SIO device registers except IO1, IO2, IRQ1, IRQ2, DMA1 DMA2  
//  Second time After Installing AmiSioProtocol, and DevicePath Protocol of SIO Device.  
//  If device requires some additional initialization like
//      - if programming of some runtime registers like SIO_GPIO, SIO_PM SIO_HHM is needed
//      - implementation of some additional setup questions 
//  do it here
//  NOTE#1 Once SIO_INIT function invoced SIO Logical device allready selected
//  NOTE#2 If Device Does not require any additional initialization just set 
//     InitRoutine field to NULL in SioDevLst[] Table.
//
// Input:
//  IN  AMI_SIO_PROTOCOL    *AmiSio - Logical Device's information
//  IN  EFI_PCI_IO_PROTOCOL *PciIo - Read/Write PCI config space
//  IN  SIO_INIT_STEP       InitStep - Initial routine step
//
// Output: None
//  EFI_STATUS
//  EFI_SUCCESS - Initial step sucessfully
//  EFI_INVALID_PARAMETER - not find the initial step
//
// Modified: Nothing
//
// Referrals: None
//
// Note:
//  It is recommended to have a separate Initialization Routine for each SIO Device.
//  it will save you some code needed to detect which device is currently selected.
//        case isGetSetupData:
//            SIO implementation uses separate set of NVRAM variables 
//            associated with each LogicalDevice who has 
//            SPIO_DEV.DeviceInfo->HasSetup property set to true.
//            Current Setup Settings are stored in SPIO_DEV.NvData. 
//            If due to different look and fill we need to overwrite standard 
//            Setup settings, we can do it here.....
//            =====================================================
//            if(SetupData==NULL){
//                Status=GetSetupData();
//                if(EFI_ERROR(Status)) return Status;
//                }
//            dev->NvData.DevEnable = SetupData->FdcEnable;
//            dev->NvData.DevPrsId  = 0;//SetupData->FdcPrsId;
//            dev->NvData.DevMode   = 0;//SetupData->FdcMode;
//            break;
//
//        case isPrsSelect:
//            If LDN uses non-standard way to determine possible resources(_PRS),
//            or _PRS may wary based  on LD mode. Then here we can get LD mode using 
//            SPIO_DEV.NvData.Mode field and get corresponded to the mode _PRS Buffer 
//            using GetPrsFromAml() function if ACPISUPPORT is ON. Or set of functions 
//            EFI_STATUS SetUartPrs(SPIO_DEV *Dev);
//            EFI_STATUS SetLptPrs(SPIO_DEV *Dev, BOOLEAN UseDma);
//            EFI_STATUS SetFdcPrs(SPIO_DEV *Dev);
//            EFI_STATUS SetPs2kPrs(SPIO_DEV *Dev);
//            EFI_STATUS SetPs2mPrs(SPIO_DEV *Dev);
//            EFI_STATUS SetGamePrs(SPIO_DEV *Dev);
//            EFI_STATUS SetMpu401Prs(SPIO_DEV *Dev);
//            Defined in GenericSio.h  
//            
//        case isBeforeActivate:
//            //If any register needs to be initialized, whle enumerating all SIO devices.        
//            //Use NEW SbLib_SetLpcDeviceDecoding() function to set Device Decoding Range for 
//            //Legacy devices. Implementation in SbGeneric.c, definition in SbCspLib.h
//            //=====================================================
//
//        case isAfterActivate:
//            //Ttis Initialization step is used to programm any runtime registers rsiding in
//            //Decvice's decoded io space like SIO_GPIOs, SIO_PM, HHM registers. 
//            //This Programming is needed if device doesnot have or don't need driver to do so.
//            //If there are a spetial driver like could be for HHM which could get THIS device handle
//            //and programm like Terminal Driver for COM ports and Floppy Driver for FDC 
//            //nothing needs to be done here
//
//        case isAfterBootScript:
//            //This initialization step is needed to 
//            //Use NEW SbLib_SetLpcDeviceDecoding() function to set Device Decoding Range for Legacy devices
//
//-------------------------------------------------------------------------
// <AMI_PHDR_END> 

// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: FDC_Init
//
// Description:
//  This function provide each initial routine in genericsio.c
//
// Input:
//  IN  AMI_SIO_PROTOCOL    *AmiSio - Logical Device's information
//  IN  EFI_PCI_IO_PROTOCOL *PciIo - Read/Write PCI config space
//  IN  SIO_INIT_STEP       InitStep - Initial routine step
//
// Output: 
//  EFI_SUCCESS - Initial step sucessfully
//  EFI_INVALID_PARAMETER - not find the initial step
//
// Modified:    Nothing
//
// Referrals:   None
//
// Notes:
//------------------------------------------------------------------------- 
// <AMI_PHDR_END> 
static EFI_STATUS FDC_Init(
    IN    AMI_SIO_PROTOCOL     *AmiSio, 
    IN    EFI_PCI_IO_PROTOCOL  *PciIo, 
    IN    SIO_INIT_STEP        InitStep 
)
{
    EFI_STATUS  Status=EFI_SUCCESS;
    SPIO_DEV    *dev=(SPIO_DEV*)AmiSio;
    UINT8       rv;     //FdcMode Register

    switch (InitStep)
    {
        case isGetSetupData:
            // Disable IODecode?
            if((!dev->DeviceInfo->Implemented) || (!dev->NvData.DevEnable))
                LoopCspIoDecodeListInit(NULL,AmiSio); 
        break;

        case isPrsSelect:
        break;

        case isBeforeActivate:
            LoopCspIoDecodeListInit(PciIo,AmiSio); // Enable IODecode 

            //AMI_TODO: please check the register define and program FDC mode

            //Read FDC Mode register
            Status=AmiSio->Access(AmiSio,FALSE,FALSE,0xF0,&rv);
            ASSERT_EFI_ERROR(Status);
            if(EFI_ERROR(Status))return Status;
    
            if(dev->NvData.DevMode)rv |= 0x10; //Bit00 set = FDD is Write Protect
            else rv &= (UINT8)(~0x10);
    
            Status=AmiSio->Access(AmiSio,TRUE,FALSE,0xF0,&rv);
            ASSERT_EFI_ERROR(Status);


        break;

        case isAfterActivate:
        break;

        #if(CORE_AFTER_4634)
        case isAfterBootScript:
        break;
        #endif

        default: Status=EFI_INVALID_PARAMETER;
    } //switch

    return Status;
}

// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: COM_Init
//
// Description:
//  This function provide each initial routine in genericsio.c
//
// Input:
//  IN  AMI_SIO_PROTOCOL    *AmiSio - Logical Device's information
//  IN  EFI_PCI_IO_PROTOCOL *PciIo - Read/Write PCI config space
//  IN  SIO_INIT_STEP       InitStep - Initial routine step
//
// Output: 
//  EFI_SUCCESS - Initial step sucessfully
//  EFI_INVALID_PARAMETER - not find the initial step
//
// Modified:  Nothing
//
// Referrals: None
//
// Notes:
//------------------------------------------------------------------------- 
// <AMI_PHDR_END> 
static EFI_STATUS COM_Init(
    IN    AMI_SIO_PROTOCOL     *AmiSio, 
    IN    EFI_PCI_IO_PROTOCOL  *PciIo, 
    IN    SIO_INIT_STEP        InitStep 
)
{
    EFI_STATUS  Status=EFI_SUCCESS;
    SPIO_DEV    *dev=(SPIO_DEV*)AmiSio;
    UINT8       rv;

    switch (InitStep)
    {
        case isGetSetupData:
            if((!dev->DeviceInfo->Implemented) || (!dev->NvData.DevEnable)) {
//                 LoopCspIoDecodeListInit(NULL,AmiSio); 
                 ClearDevResource(dev);
            }
        break;
    
        case isPrsSelect:
        break;

        case isBeforeActivate:

//            //Only decode UART1/UART2. More others UART port is decode in PEI
//            //Attention! Remove the more com ports to PEI decode.
//            if(dev->DeviceInfo->UID <= 0x02)
//                LoopCspIoDecodeListInit(PciIo,AmiSio);
        
            //Programm Device Mode register here(if NEEDED)use AmiSioProtocol
//            if(DXE_COM_Mode_Init_Table[dev->DeviceInfo->UID].AndData8 == 0xFF) {
//                rv=DXE_COM_Mode_Init_Table[dev->DeviceInfo->UID].OrData8;
//            } else {
//                Status=AmiSio->Access(AmiSio, FALSE, FALSE, 0xF0, &rv);
//                ASSERT_EFI_ERROR(Status);
//                rv &= DXE_COM_Mode_Init_Table[dev->DeviceInfo->UID].AndData8;
//                rv |= DXE_COM_Mode_Init_Table[dev->DeviceInfo->UID].OrData8;
//            }
//			Status=AmiSio->Access(AmiSio,TRUE,FALSE,0xF0,&rv);            

            //AMI_TODO: You can program device mode as follow:

//            if(dev->DeviceInfo->UID == 0x05)    {
//                    Status=AmiSio->Access(AmiSio,FALSE,FALSE,0xF1,&rv);
//					ASSERT_EFI_ERROR(Status);
//					if(EFI_ERROR(Status))return Status;
//					//clear Bit4~3 where COM Port mode is:
//					rv &= 0xE7;            
//					switch (dev->NvData.DevMode) {
//						case 0:
//							rv |= 0x00;    //Bit4~3 = 000, Disable IR1 function
//						break;
//						case 1:
//							rv |= 0x10;    //Bit4~3 = 010, Enable IR1 function, active pulse is 1.6uS
//						break;
//						case 2:
//							rv |= 0x18;    //Bit4~3 = 011, Enable IR1 function, active pulse is 3/16 bit time
//						break;
//						default: return EFI_INVALID_PARAMETER;
//					}
//					Status=AmiSio->Access(AmiSio,TRUE,FALSE,0xF1,&rv);
//					ASSERT_EFI_ERROR(Status);
//                }
           
//                //Programm Serial_X IRQ Share register.
//                if((dev->DeviceInfo->Flags & SIO_SHR_IRQ1) && dev->ResOwner) { 
//                    //enter cfgmode
//                    SioCfgMode(dev->Owner, TRUE);
//                    //set device resource owner share register
//                    DevSelect(dev->ResOwner);
//                      SioRegister(dev->ResOwner, FALSE, 0xF0, &rv);//read reg0xF0 value
//                      rv |= 0x01; //Bit1:share or normal
//                      SioRegister(dev->ResOwner, TRUE, 0xF0, &rv);//write reg0xF0 value
//                    //set device irq register
//                    DevSelect(dev);
//                      SioRegister(dev->ResOwner, FALSE, 0x70, &rv);//read reg0x70 value
//                      SioRegister(dev, TRUE, 0x70, &rv);//write reg0x70 value
//                      SioRegister(dev, FALSE, 0xF0, &rv);//read reg0xF0 value
//                      rv |= 0x01; //Bit1:share or normal
//                      SioRegister(dev, TRUE, 0xF0, &rv);//write reg0xF0 value
//                    //exit cfgmode
//                    SioCfgMode(dev->Owner, FALSE);
//                    dev->VlData.DevIrq1=dev->ResOwner->VlData.DevIrq1;
//                }

            Status=AmiSio->Access(AmiSio, FALSE, FALSE, 0xF0, &rv);
            rv &= ~(BIT0) ;
            Status=AmiSio->Access(AmiSio,TRUE,FALSE,0xF0,&rv);
        break;
            
        case isAfterActivate:
        break;

        #if(CORE_AFTER_4634)
        case isAfterBootScript:
        break;
        #endif

        default: Status=EFI_INVALID_PARAMETER;
    }//switch
    return Status;
}

// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: LPT_Init
//
// Description:
//  This function provide each initial routine in genericsio.c
//
// Input:
//  IN  AMI_SIO_PROTOCOL    *AmiSio - Logical Device's information
//  IN  EFI_PCI_IO_PROTOCOL *PciIo - Read/Write PCI config space
//  IN  SIO_INIT_STEP       InitStep - Initial routine step
//
// Output: 
//  EFI_SUCCESS - Initial step sucessfully
//  EFI_INVALID_PARAMETER - not find the initial step
//
// Modified:  Nothing
//
// Referrals: None
//
// Notes:
//------------------------------------------------------------------------- 
// <AMI_PHDR_END> 
static EFI_STATUS LPT_Init(
    IN    AMI_SIO_PROTOCOL     *AmiSio, 
    IN    EFI_PCI_IO_PROTOCOL  *PciIo, 
    IN    SIO_INIT_STEP        InitStep 
)
{
    EFI_STATUS  Status=EFI_SUCCESS;
    SPIO_DEV    *dev=(SPIO_DEV*)AmiSio;
    UINT8       rv;                //LptMode Register    

    switch (InitStep) {
        case isGetSetupData:
//            // Disable decode?
//            if((!dev->DeviceInfo->Implemented) || (!dev->NvData.DevEnable))
//                LoopCspIoDecodeListInit(NULL,AmiSio); 
        break;
    
        case isPrsSelect:
            //depend on LPT Mode it may or may not use a DMA channel
            Strcpy(&dev->DeviceInfo->AslName[0],"LPTE");
            if(dev->NvData.DevMode&0x04) {
                #if ACPI_SUPPORT
                //if ACPI is Supported get _PRS for Extended Parallel Port from DSDT 
                //last parameter is 0-based index in F81866_DevLst[] table.
                Status=GetPrsFromAml(dev,"EPPR", 1);
                #else
                //if ACPI is not supported use corresponded Function seting 
                //"UseDma" parameter to TRUE for Extended Parallel Port
                Status=SetLptPrs(dev, TRUE);
                #endif
            }else { 
                #if ACPI_SUPPORT
                //if ACPI is Supported get _PRS for Standard Parallel Port from DSDT 
                //last parameter is 0-based index in WPCD376I_DevLst[] table.
                Status=GetPrsFromAml(dev,"LPPR", 1);
                #else
                //if ACPI is not supported use corresponded Function seting 
                //"UseDma" parameter to FALSE for Standard Parallel Port
                Status=SetLptPrs(dev, FALSE);
                #endif
            }
            ASSERT_EFI_ERROR(Status);

        break;

        case isBeforeActivate:
//            LoopCspIoDecodeListInit(PciIo,AmiSio);   // Enable IODecode

            //Programm Device Mode register here(if NEEDED)use AmiSioProtocol  

            //AMI_TODO: You can program device mode as follow:

            //Programm Device Mode register here(if NEEDED)use AmiSioProtocol  
            Status=AmiSio->Access(AmiSio,FALSE,FALSE,0xF0,&rv);    //LPT Configuration Reg, Read the reg value
            ASSERT_EFI_ERROR(Status);
            if(EFI_ERROR(Status))return Status;

            //Program Lpt Mode register following SIO Specification instructions. 
            //Set mode:Bit2-0 set = LPT mode
            //clear lowest 3 bits where LPT mode is:
            rv&=0xF8;                                 
            switch (dev->NvData.DevMode) {
                    case 0:    rv|=4; //STD Printer Mode
                        break;
                    case 1:    rv|=0; //SPP Mode
                        break;
                    case 2:    rv|=1; //EPP-1.9 and SPP Mode
                        break;
                    case 3:    rv|=5; //EPP-1.7 and SPP Mode
                        break;
                    case 4:    rv|=2; //ECP Mode 
                        break;
                    case 5:    rv|=3; //ECP and EPP-1.9 Mode
                        break;
                    case 6:    rv|=7; //ECP and EPP-1.7 Mode
                        break;
                default: return EFI_INVALID_PARAMETER;
            }
            //Program back Device Mode register
            Status=AmiSio->Access(AmiSio,TRUE,FALSE,0xF0,&rv);
            ASSERT_EFI_ERROR(Status);

        break;

        case isAfterActivate:
        break;

        #if(CORE_AFTER_4634)
        case isAfterBootScript:
        break;
        #endif

        default: Status=EFI_INVALID_PARAMETER;
    } //switch

    return Status;
}

// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: KBC_Init
//
// Description:
//  This function provide each initial routine in genericsio.c
//
// Input:
//  IN  AMI_SIO_PROTOCOL    *AmiSio - Logical Device's information
//  IN  EFI_PCI_IO_PROTOCOL *PciIo - Read/Write PCI config space
//  IN  SIO_INIT_STEP       InitStep - Initial routine step
//
// Output: 
//  EFI_SUCCESS - Initial step sucessfully
//  EFI_INVALID_PARAMETER - not find the initial step
//
// Modified:  Nothing
//
// Referrals: None
//
// Notes:
//------------------------------------------------------------------------- 
// <AMI_PHDR_END> 
static EFI_STATUS KBC_Init(
    IN    AMI_SIO_PROTOCOL     *AmiSio, 
    IN    EFI_PCI_IO_PROTOCOL  *PciIo, 
    IN    SIO_INIT_STEP        InitStep 
)
{
    EFI_STATUS  Status=EFI_SUCCESS;

    switch (InitStep) {
        case isGetSetupData:
        case isPrsSelect:
        case isAfterActivate:
        #if(CORE_AFTER_4634)
        case isAfterBootScript:
        #endif
        break;

        case isBeforeActivate:
//            LoopCspIoDecodeListInit(PciIo,AmiSio);  // Enable IODecode
        break;

        default: Status=EFI_INVALID_PARAMETER;
    } //switch

    return Status;
}

// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: PME_Init
//
// Description:
//  This function provide each initial routine in genericsio.c
//
// Input:
//  IN  AMI_SIO_PROTOCOL    *AmiSio - Logical Device's information
//  IN  EFI_PCI_IO_PROTOCOL *PciIo - Read/Write PCI config space
//  IN  SIO_INIT_STEP       InitStep - Initial routine step
//
// Output: 
//  EFI_SUCCESS - Initial step sucessfully
//  EFI_INVALID_PARAMETER - not find the initial step
//
// Modified:  Nothing
//
// Referrals: None
//
// Notes:
//------------------------------------------------------------------------- 
// <AMI_PHDR_END> 
static EFI_STATUS PME_Init(
    IN    AMI_SIO_PROTOCOL     *AmiSio, 
    IN    EFI_PCI_IO_PROTOCOL  *PciIo, 
    IN    SIO_INIT_STEP        InitStep 
)
{
    EFI_STATUS  Status=EFI_SUCCESS;

    #if F81866_PME_CONTROLLER_PRESENT


    switch (InitStep) {
        case isGetSetupData:
        break;

        case isPrsSelect:
        break;

        case isBeforeActivate:
          // OEM_TODO: You need to fill DXE_PME_Init_Table[] first.
       
        break;
        
        case isAfterActivate:
        break;

        #if(CORE_AFTER_4634)
        case isAfterBootScript:
        break;
        #endif

        default: Status=EFI_INVALID_PARAMETER;
    } //switch
    #endif

    return Status;
}

// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: HWM_Init
//
// Description:
//  This function provide each initial routine in genericsio.c
//
// Input:
//  IN  AMI_SIO_PROTOCOL    *AmiSio - Logical Device's information
//  IN  EFI_PCI_IO_PROTOCOL *PciIo - Read/Write PCI config space
//  IN  SIO_INIT_STEP       InitStep - Initial routine step
//
// Output: 
//  EFI_SUCCESS - Initial step sucessfully
//  EFI_INVALID_PARAMETER - not find the initial step
//
// Modified:  Nothing
//
// Referrals: None
//
// Notes:
//------------------------------------------------------------------------- 
// <AMI_PHDR_END> 
static EFI_STATUS HWM_Init(
    IN    AMI_SIO_PROTOCOL     *AmiSio, 
    IN    EFI_PCI_IO_PROTOCOL  *PciIo, 
    IN    SIO_INIT_STEP        InitStep 
)
{
    EFI_STATUS  Status=EFI_SUCCESS;
    SPIO_DEV    *dev=(SPIO_DEV*)AmiSio;
    BootScriptProtocol = dev->Owner->BootScript;     

    #if F81866_HWM_PRESENT

    switch (InitStep) {
        case isGetSetupData:
        break;

        case isPrsSelect:
        break;

        case isBeforeActivate:
        // HWM registers initial if needed.
        // AMI_TODO: Add init function for configure HWM SIO space.
        
        break;
        
        case isAfterActivate:
        // HWM registers initial if needed.
        // AMI_TODO: Add init function for configure HWM SIO space.
            ProgramIsaRegisterTable(F81866_HWM_BASE_ADDRESS+0x05, \
                    F81866_HWM_BASE_ADDRESS+0x06, \
                    DXE_HWM_Init_Table_After_Active,                   
                    sizeof(DXE_HWM_Init_Table_After_Active)/sizeof(DXE_DEVICE_INIT_DATA));

            #if F81866_SMF_SUPPORT
                F81866SmartFunction();
			#endif
        break;

        #if(CORE_AFTER_4634)
        case isAfterBootScript:
        //AMI_TODO:
        // Restore HWM registers after Sx resume, if needed.
        // Below HWM read/write interface is LPC/ISA interface, 
        // if other interface, please re-program it.
        // This, Width, Address, Count, Buffer
            SaveSxSioRegisterTable(F81866_HWM_BASE_ADDRESS+0x05, \
                            F81866_HWM_BASE_ADDRESS+0x06, \
                            DXE_HWM_SIO_BootScript_Table,                           
                            sizeof(DXE_HWM_SIO_BootScript_Table)/sizeof(UINT8));
        break;
        #endif


        default: Status=EFI_INVALID_PARAMETER;
    } //switch
    #endif

    return Status;
}

// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: GPIO_Init
//
// Description:
//  This function provide each initial routine in genericsio.c
//
// Input:
//  IN  AMI_SIO_PROTOCOL    *AmiSio - Logical Device's information
//  IN  EFI_PCI_IO_PROTOCOL *PciIo - Read/Write PCI config space
//  IN  SIO_INIT_STEP       InitStep - Initial routine step
//
// Output: 
//  EFI_SUCCESS - Initial step sucessfully
//  EFI_INVALID_PARAMETER - not find the initial step
//
// Modified:  Nothing
//
// Referrals: None
//
// Notes:
//------------------------------------------------------------------------- 
// <AMI_PHDR_END> 
static EFI_STATUS GPIO_Init(
    IN    AMI_SIO_PROTOCOL     *AmiSio, 
    IN    EFI_PCI_IO_PROTOCOL  *PciIo, 
    IN    SIO_INIT_STEP        InitStep 
)
{
    EFI_STATUS  Status=EFI_SUCCESS;    
    #if F81866_GPIO_PORT_PRESENT
 

    switch (InitStep) {
        case isGetSetupData:
        break;

        case isPrsSelect:
        break;

        case isBeforeActivate:

        break;
        case isAfterActivate:
        break;

        #if(CORE_AFTER_4634)
        case isAfterBootScript:
        break;
        #endif

        default: Status=EFI_INVALID_PARAMETER;
    } //switch
    #endif

    return Status;
}

// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: WDT_Init
//
// Description:
//  This function provide each initial routine in genericsio.c
//
// Input:
//  IN  AMI_SIO_PROTOCOL    *AmiSio - Logical Device's information
//  IN  EFI_PCI_IO_PROTOCOL *PciIo - Read/Write PCI config space
//  IN  SIO_INIT_STEP       InitStep - Initial routine step
//
// Output: 
//  EFI_SUCCESS - Initial step sucessfully
//  EFI_INVALID_PARAMETER - not find the initial step
//
// Modified:  Nothing
//
// Referrals: None
//
// Notes:
//------------------------------------------------------------------------- 
// <AMI_PHDR_END> 
static EFI_STATUS WDT_Init(
    IN    AMI_SIO_PROTOCOL     *AmiSio, 
    IN    EFI_PCI_IO_PROTOCOL  *PciIo, 
    IN    SIO_INIT_STEP        InitStep 
)
{
    EFI_STATUS  Status=EFI_SUCCESS;    

    switch (InitStep) {
        case isGetSetupData:
        break;

        case isPrsSelect:
        break;

        case isBeforeActivate:

        break;
        case isAfterActivate:
        break;

        #if(CORE_AFTER_4634)
        case isAfterBootScript:
        break;
        #endif

        default: Status=EFI_INVALID_PARAMETER;
    } //switch

    return Status;
}

//-------------------------------------------------------------------------
//!!!!!!!!!!! Porting  End  !!!!!!!!!!! 
//-------------------------------------------------------------------------
// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: ClearDevResource
//
// Description:
//  This function will Clear SIO resource
//
// Input:
//  SPIO_DEV* dev
// Output: 
//  NONE
//
//------------------------------------------------------------------------- 
// <AMI_PHDR_END>
VOID ClearDevResource(
    IN    SPIO_DEV* dev)
{
    UINT8   Value8;
    Value8=0x00;
    SioCfgMode(dev->Owner, TRUE);
    DevSelect(dev);
    SioRegister(dev, TRUE,F81866_BASE1_HI_REGISTER,&Value8);
    SioRegister(dev, TRUE,F81866_BASE1_LO_REGISTER,&Value8);
//    SioRegister(dev, TRUE,F81866_BASE2_HI_REGISTER,&Value8);
//    SioRegister(dev, TRUE,F81866_BASE2_LO_REGISTER,&Value8);
    SioRegister(dev, TRUE,F81866_IRQ1_REGISTER,&Value8);
//    SioRegister(dev, TRUE,F81866_IRQ2_REGISTER,&Value8);
//    SioRegister(dev, TRUE,F81866_DMA1_REGISTER,&Value8);
//    SioRegister(dev, TRUE,F81866_DMA2_REGISTER,&Value8);
    SioCfgMode(dev->Owner, FALSE);
    return;

}
// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: ProgramSioRegisterTable
//
// Description:
//  This function will Program the SIO config space.
//
// Input:
//  IN  DXE_DEVICE_INIT_DATA    *Table - initial table
//  IN  UINT8                   Count    Table Length
//
// Output: 
//  NONE
//
//------------------------------------------------------------------------- 
// <AMI_PHDR_END> 
VOID ProgramSioRegisterTable(
    IN  AMI_SIO_PROTOCOL    *AmiSio,
    IN  DXE_DEVICE_INIT_DATA *Table,    
    IN  UINT8               Count
)
{
    UINT8   i;
    UINT8   Value8;
 
    for(i=0;i<Count;i++) {
        if(Table[i].AndData8 == 0xFF)
            Value8=Table[i].OrData8;
        else {
            AmiSio->Access(AmiSio, FALSE, FALSE, (UINT8)(Table[i].Reg16), &Value8);
            Value8 &= Table[i].AndData8;
            Value8 |= Table[i].OrData8;
        }
        AmiSio->Access(AmiSio, TRUE, FALSE, (UINT8)(Table[i].Reg16), &Value8);
    }

    return;
}

// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: ProgramIsaRegisterTable
//
// Description:
//  This function will Program the SIO config space.
//
// Input:
//  IN  UINT16  Index - Index port   
//  IN  UINT16  Data - Data port
//  IN  UINT16  *Table - initial table
//  IN  UINT8   Count    Table Length
//
// Output: 
//  NONE
//
//------------------------------------------------------------------------- 
// <AMI_PHDR_END> 
VOID ProgramIsaRegisterTable(
    IN  UINT16  Index,
    IN  UINT16  Data,
    IN  DXE_DEVICE_INIT_DATA *Table,
    IN  UINT8   Count
)
{
    UINT8   i;
    UINT8   Value8;
 
    for(i=0;i<Count;i++) {
        if(Table[i].AndData8 == 0xFF)
            Value8=Table[i].OrData8;
        else {
            IoWrite8(Index, (UINT8)(Table[i].Reg16));
            Value8 = IoRead8(Data);
            Value8 &= Table[i].AndData8;
            Value8 |= Table[i].OrData8;
        }
        IoWrite8(Index, (UINT8)(Table[i].Reg16));
        IoWrite8(Data, Value8);
    }

    return;
}
// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: ProgramRtRegisterTable
//
// Description:
//  This function will program the runtime register.
//
// Input:
//  IN  UINT16  Base - Runtime register IO base
//  IN  DXE_DEVICE_INIT_DATA  *Table - initial table
//  IN  UINT8                   Count    Table Length
//
// Output: 
//  NONE
//
//------------------------------------------------------------------------- 
// <AMI_PHDR_END> 
VOID ProgramRtRegisterTable(
    IN  UINT16  Base,
    IN  DXE_DEVICE_INIT_DATA  *Table,    
    IN  UINT8   Count

)
{
    UINT8   i;
    UINT8   Value8;

    for(i=0;i<Count;i++) {
        if(Table[i].AndData8 == 0xFF)
            Value8 = Table[i].OrData8;
        else
            Value8 = (IoRead8(Base+Table[i].Reg16) & Table[i].AndData8)|\
                     Table[i].OrData8;
        IoWrite8(Base+Table[i].Reg16, Value8 );
    }
}

// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: SaveSxSioRegisterTable
//
// Description:
//  This function will Save the SIO registers to boot script Table
//
// Input:
//  IN  UINT16  Index - Index port   
//  IN  UINT16  Data - Data port
//  IN  UINT16  *Table - initial table
//  IN  UINT8   Count    Table Length
//
// Output: 
//  NONE
//
//------------------------------------------------------------------------- 
// <AMI_PHDR_END> 
VOID SaveSxSioRegisterTable(
    IN  UINT16  Index,
    IN  UINT16  Data,
    IN  UINT8   *Table,    
    IN  UINT8   Count
)
{
    UINT8   i;
    UINT8   Value8;

    for(i=0;i<Count;i++) {
      IoWrite8(Index,Table[i]);
      BOOT_SCRIPT_S3_IO_WRITE_MACRO(BootScriptProtocol,
                                  EfiBootScriptWidthUint8,
                                  Index,
                                  1,
                                  &Table[i]);
      Value8 = IoRead8(Data);
      BOOT_SCRIPT_S3_IO_WRITE_MACRO(BootScriptProtocol,
                                  EfiBootScriptWidthUint8,
                                  Data,
                                  1,
                                  &Value8);
    }

    return;
}

// <AMI_PHDR_START>
//-------------------------------------------------------------------------
//
// Procedure: SaveSxRtRegisterTable
//
// Description:
//  This function will Save the runtime registers to boot script Table
//
// Input:
//  IN  UINT16  Index - Index port   
//  IN  UINT16  Data - Data port
//  IN  UINT16  *Table - initial table
//  IN  UINT8   Count    Table Length
//
// Output: 
//  NONE
//
//------------------------------------------------------------------------- 
// <AMI_PHDR_END>
VOID SaveSxRtRegisterTable(
    IN  UINT16  Base,
    IN  UINT16  *Table,    
    IN  UINT8   Count
)
{
    UINT8   i;
    UINT8   Value8;

    for(i=0;i<Count;i++) {
        Value8 = IoRead8(Base+Table[i]);
        BOOT_SCRIPT_S3_IO_WRITE_MACRO(BootScriptProtocol,
                                    EfiBootScriptWidthUint8,
                                    (Base+Table[i]),
                                    1,
                                    &Value8);
    }

    return;

}

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