summaryrefslogtreecommitdiffstats
path: root/private/ntos/ndis/madge/driver/madge.c
blob: 9e3e22dda144c5c0d1cfacc57e8ced61b9683024 (plain) (blame)
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
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
/***************************************************************************
*
* MADGE.C
*
* FastMAC Plus based NDIS3 miniport driver entry, initialisation and
* closedown module.
*
* Copyright (c) Madge Networks Ltd 1994                                     
*
* COMPANY CONFIDENTIAL
*
* Created: PBA 21/06/1994
*                                                                          
****************************************************************************/

#include <ndis.h>

#include "ftk_defs.h"
#include "ftk_extr.h"
#include "ftk_intr.h"

#include "mdgmport.upd"
#include "ndismod.h"

/*---------------------------------------------------------------------------
|
| Identification string for MVER.
|
---------------------------------------------------------------------------*/

char MVerString[] = MVER_STRING;


/*---------------------------------------------------------------------------
|
| Option strings for registry queries.
|
| There is a lot of fuss here to get the various strings defined in the 
| correct way - those that are optional need to be defined in the parm. 
| table as string constants, while those that are passed directly to the
| registry query functions need to be explicitly defined outside any 
| structures.
|
|--------------------------------------------------------------------------*/

#define HIDDEN_OFFS 0x80

#define EmptyString           NDIS_STRING_CONST("")

//
// These are the NT versions of the option strings.
//

#define IOAddrString          NDIS_STRING_CONST("IoLocation")
#define IOBaseString          NDIS_STRING_CONST("IoBaseAddress")
#define InterruptNumString    NDIS_STRING_CONST("InterruptNumber")
#define DMAChanString         NDIS_STRING_CONST("DmaChannel")
#define TxSlotNumString       NDIS_STRING_CONST("TxSlots")
#define RxSlotNumString       NDIS_STRING_CONST("RxSlots")
#define MaxFrameSizeString    NDIS_STRING_CONST("MaxFrameSize")
#define CardBuffSizeString    NDIS_STRING_CONST("CardBufferSize")
#define AlternateIoString     NDIS_STRING_CONST("Alternate")
#define TestAndXIDString      NDIS_STRING_CONST("TestAndXIDEnabled")
#define RxTxSlotsString       NDIS_STRING_CONST("RxTxSlots")
#define ForceOpenString       NDIS_STRING_CONST("ForceOpen")
#define Force4String          NDIS_STRING_CONST("Force4")
#define Force16String         NDIS_STRING_CONST("Force16")
#define SlotNumString         NDIS_STRING_CONST("SlotNumber")
#define NoPciMmioString       NDIS_STRING_CONST("NoMmio")
#define RingSpeedString       NDIS_STRING_CONST("RingSpeed")
#define AdapterTypeString     NDIS_STRING_CONST("AdapterType")
#define MmioAddrString        NDIS_STRING_CONST("MemBase")
#define PlatformTypeString    NDIS_STRING_CONST("PlatformType")
#define TransferTypeString    NDIS_STRING_CONST("TransferType")

WCHAR PromModeString[] = 
    { L'P' + HIDDEN_OFFS, L'r' + HIDDEN_OFFS, L'o' + HIDDEN_OFFS, 
      L'm' + HIDDEN_OFFS, L'i' + HIDDEN_OFFS, L's' + HIDDEN_OFFS, 
      L'c' + HIDDEN_OFFS, L'u' + HIDDEN_OFFS, L'o' + HIDDEN_OFFS, 
      L'u' + HIDDEN_OFFS, L's' + HIDDEN_OFFS, L'M' + HIDDEN_OFFS, 
      L'o' + HIDDEN_OFFS, L'd' + HIDDEN_OFFS, L'e' + HIDDEN_OFFS, 
      L'X' + HIDDEN_OFFS, 000 };

#define PromiscuousString { sizeof(PromModeString) - 2, \
                            sizeof(PromModeString),     \
                            PromModeString }

//
// These strings are passed direct to NdisReadConfiguration.
//

STATIC NDIS_STRING BusTypeString         = NDIS_STRING_CONST("BusType");
STATIC NDIS_STRING BusNumberString       = NDIS_STRING_CONST("BusNumber");
STATIC NDIS_STRING IOAddressString       = IOAddrString;
STATIC NDIS_STRING IOBaseAddrString      = IOBaseString;
STATIC NDIS_STRING InterruptNumberString = InterruptNumString;
STATIC NDIS_STRING DMAChannelString      = DMAChanString;
STATIC NDIS_STRING SlotNumberString      = SlotNumString;
STATIC NDIS_STRING NoMmioString          = NoPciMmioString;
STATIC NDIS_STRING AdapterString         = AdapterTypeString;
STATIC NDIS_STRING MmioAddressString     = MmioAddrString;
STATIC NDIS_STRING PlatformString        = PlatformTypeString;
STATIC NDIS_STRING TransferModeString    = TransferTypeString;

STATIC NDIS_STRING NullString            = EmptyString;


/*---------------------------------------------------------------------------
|
| Optional parameter structure.
|
|--------------------------------------------------------------------------*/

//
// The Keyword parameters here use the #define's above, so the compiler is
// kept happy about string initialisers. 
//

STATIC struct
{
    MADGE_PARM_DEFINITION               TxSlots;
    MADGE_PARM_DEFINITION               RxSlots;
    MADGE_PARM_DEFINITION               MaxFrameSize;
    MADGE_PARM_DEFINITION               CardBufferSize;
    MADGE_PARM_DEFINITION               PromiscuousMode;
    MADGE_PARM_DEFINITION               AlternateIo;
    MADGE_PARM_DEFINITION               TestAndXIDEnabled;
    MADGE_PARM_DEFINITION               RxTxSlots;
    MADGE_PARM_DEFINITION               ForceOpen;
    MADGE_PARM_DEFINITION               Force4;
    MADGE_PARM_DEFINITION               Force16;
    MADGE_PARM_DEFINITION               RingSpeed;
    MADGE_PARM_DEFINITION               NullParm;
}
MadgeParmTable =
{
    {TxSlotNumString,      2,    32,      {NdisParameterInteger, 0}},
    {RxSlotNumString,      2,    32,      {NdisParameterInteger, 0}},
    {MaxFrameSizeString,   1024, 17839,   {NdisParameterInteger, 4096}},
    {CardBuffSizeString,   0,    0xFFFF,  {NdisParameterInteger, 0}},
    {PromiscuousString,    0,    1,       {NdisParameterInteger, 0}},
    {AlternateIoString,    0,    1,       {NdisParameterInteger, 0}},
    {TestAndXIDString,     0,    1,       {NdisParameterInteger, 0}},
    {RxTxSlotsString,      0,    5,       {NdisParameterInteger, 2}},
    {ForceOpenString,      0,    1,       {NdisParameterInteger, 0}},
    {Force4String,         0,    1,       {NdisParameterInteger, 0}},
    {Force16String,        0,    1,       {NdisParameterInteger, 0}},
    {RingSpeedString,      0,    2,       {NdisParameterInteger, 0}},
    {EmptyString}
};


/*---------------------------------------------------------------------------
|
| Name of the FastMAC Plus image file.
|
|--------------------------------------------------------------------------*/

STATIC NDIS_STRING FmpImageFileName = MADGE_FMP_NAME;


/*---------------------------------------------------------------------------
|
| List of PCI adapters in use.
|
---------------------------------------------------------------------------*/

STATIC struct 
{
    UINT BusNumber;
    UINT SlotNumber;
}
PciSlotsUsedList[MAX_NUMBER_OF_ADAPTERS];

STATIC int 
PciSlotsUsedCount = 0;


/****************************************************************************
*
* NDIS3 level adapter structure pointer table.
*
****************************************************************************/


/*---------------------------------------------------------------------------
|
| Function    - MadgeReadRegistryForMC
|
| Parameters  - wrapperConfigHandle  -> Wrapper context handle.
|               registryConfigHandle -> Already open registry query handle.
|               ndisAdap             -> Pointer to an NDIS3 level adapter
|                                       structure.
|
| Purpose     - Read configuration information for MC adapters out of 
Ý               the registry.
|
| Returns     - An NDIS3 status code.
|
|--------------------------------------------------------------------------*/

STATIC NDIS_STATUS
MadgeReadRegistryForMC(
    NDIS_HANDLE    wrapperConfigHandle,
    NDIS_HANDLE    registryConfigHandle,
    PMADGE_ADAPTER ndisAdap
    );

#pragma FTK_INIT_FUNCTION(MadgeReadRegistryForMC)

STATIC NDIS_STATUS
MadgeReadRegistryForMC(
    NDIS_HANDLE    wrapperConfigHandle,
    NDIS_HANDLE    registryConfigHandle,
    PMADGE_ADAPTER ndisAdap
    )
{
    static WORD mcaIrqMap[4] = {     0,      3,      9,     10};
    static WORD mcaIoMap[8]  = {0x0a20, 0x1a20, 0x2a20, 0x3a20,
                                0x0e20, 0x1e20, 0x2e20, 0x3e20};

    NDIS_STATUS                    status;
    PNDIS_CONFIGURATION_PARAMETER  configParam;
    UINT                           slotNumber;
    NDIS_MCA_POS_DATA              mcaData;
    BYTE                           iOSelect;

    //
    // Note the information that is always true for MC adapters.
    //

    ndisAdap->NTCardBusType  = NdisInterfaceMca;
    ndisAdap->FTKCardBusType = ADAPTER_CARD_MC_BUS_TYPE;
    ndisAdap->TransferMode   = DMA_DATA_TRANSFER_MODE;

    //
    // MicroChannel is easy - the POS registers contain all the info 
    // we need, so read those and save the information.
    //

    NdisReadMcaPosInformation(
    	&status,
    	wrapperConfigHandle,
    	&slotNumber,
    	&mcaData
    	);

    if (status != NDIS_STATUS_SUCCESS)
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_MISSING_CONFIGURATION_PARAMETER,
            2,
            readRegistry,
            MADGE_ERRMSG_NO_MCA_POS
            );

	return status;
    }

    //
    // Decode the Interrupt Number. Note: the FTK will throw
    // IRQ 0 out as invalid.
    //

    ndisAdap->UsedInISR.InterruptNumber = mcaIrqMap[mcaData.PosData1 >> 6];

    //
    // NB: Arbitration Level 15 => PIO, which we do not allow - 
    //     the FTK will throw this out as an invalid DMA channel.
    // NB: We call it DmaChannel to be compatible with ISA cards.
    //

    ndisAdap->DmaChannel = (mcaData.PosData1 >> 1) & 0x0F;

    //
    // Build the IO Location select value from several sources.
    //

    iOSelect  = (mcaData.PosData1 >> 5) & 0x01;
    iOSelect |= (mcaData.PosData4 >> 4) & 0x02;
    iOSelect |= (mcaData.PosData3 >> 0) & 0x04;

    //
    // NB: IO locations 0x2e20 and 0x3e20 are only valid for 
    // MC32 cards, but the .ADF file will have prevented them 
    // being set for MC16s.
    //

    ndisAdap->IoLocation1               = mcaIoMap[iOSelect];
    ndisAdap->UsedInISR.InterruptMode   = NdisInterruptLevelSensitive;
    ndisAdap->UsedInISR.InterruptShared = TRUE;
    ndisAdap->IORange1                  = MC_IO_RANGE;

    return NDIS_STATUS_SUCCESS;
}


/*---------------------------------------------------------------------------
|
| Function    - MadgeReadRegistryForEISA
|
| Parameters  - wrapperConfigHandle  -> Wrapper context handle.
|               registryConfigHandle -> Already open registry query handle.
|               ndisAdap             -> Pointer to an NDIS3 level adapter
|                                       structure.
|
| Purpose     - Read configuration information for an EISA adapter
Ý               out of the registry.
|
| Returns     - An NDIS3 status code.
|
|--------------------------------------------------------------------------*/

STATIC NDIS_STATUS
MadgeReadRegistryForEISA(
    NDIS_HANDLE    wrapperConfigHandle,
    NDIS_HANDLE    registryConfigHandle,
    PMADGE_ADAPTER ndisAdap
    );

#pragma FTK_INIT_FUNCTION(MadgeReadRegistryForEISA)

STATIC NDIS_STATUS
MadgeReadRegistryForEISA(
    NDIS_HANDLE    wrapperConfigHandle,
    NDIS_HANDLE    registryConfigHandle,
    PMADGE_ADAPTER ndisAdap
    )
{
    NDIS_STATUS                    status;
    PNDIS_CONFIGURATION_PARAMETER  configParam;
    UINT                           slotNumber;
    NDIS_EISA_FUNCTION_INFORMATION eisaData;

    //
    // For Eisa bus systems, we could have an Isa card or an Eisa
    // card - try to read the Eisa information, and if that fails
    // MadgeReadRegistry will assume it is an Isa card instead.
    //

    NdisReadEisaSlotInformation(
        &status,
	wrapperConfigHandle,
	&slotNumber,
	&eisaData
	);

    if (status != NDIS_STATUS_SUCCESS)
    {
        return status;
    }

    //
    // Note the information that is always true for EISA
    // adapters.
    //

    ndisAdap->NTCardBusType  = NdisInterfaceEisa;
    ndisAdap->FTKCardBusType = ADAPTER_CARD_EISA_BUS_TYPE;
    ndisAdap->TransferMode   = DMA_DATA_TRANSFER_MODE;

    //
    // Got EISA configuration data - decode the relevant bits.
    //

    ndisAdap->IoLocation1 = slotNumber << 12;

    //
    // Get the Interrupt number from the NVRAM data - we know it
    // is going to be the first Irq element in the Irq array
    // because the card only uses one interrupt. 
    //

    ndisAdap->UsedInISR.InterruptNumber = 
        eisaData.EisaIrq[0].ConfigurationByte.Interrupt;

    ndisAdap->UsedInISR.InterruptMode = (NDIS_INTERRUPT_MODE)
        (eisaData.EisaIrq[0].ConfigurationByte.LevelTriggered 
    	    ? NdisInterruptLevelSensitive 
	    : NdisInterruptLatched);

    ndisAdap->UsedInISR.InterruptShared = (BOOLEAN)
        eisaData.EisaIrq[0].ConfigurationByte.Shared;

    //
    // For EISA cards we don't care what the DMA setting is. So 
    // we leave it set to 0 forget about it.
    //

    ndisAdap->IORange1    = EISA_IO_RANGE;
    ndisAdap->IoLocation2 = ndisAdap->IoLocation1 + EISA_IO_RANGE2_BASE;
    ndisAdap->IORange2    = EISA_IO_RANGE2;

    return NDIS_STATUS_SUCCESS;
}


/*---------------------------------------------------------------------------
|
| Function    - MadgeReadRegistryForISA
|
| Parameters  - wrapperConfigHandle  -> Wrapper context handle.
|               registryConfigHandle -> Already open registry query handle.
|               ndisAdap             -> Pointer to an NDIS3 level adapter
|                                       structure.
Ý               adapterType          -> Adapter type.
|
| Purpose     - Read configuration information for ISA adapters out 
Ý               of the registry.
|
| Returns     - An NDIS3 status code.
|
|--------------------------------------------------------------------------*/

STATIC NDIS_STATUS
MadgeReadRegistryForISA(
    NDIS_HANDLE    wrapperConfigHandle,
    NDIS_HANDLE    registryConfigHandle,
    PMADGE_ADAPTER ndisAdap,
    ULONG          adapterType
    );

#pragma FTK_INIT_FUNCTION(MadgeReadRegistryForISA)

STATIC NDIS_STATUS
MadgeReadRegistryForISA(
    NDIS_HANDLE    wrapperConfigHandle,
    NDIS_HANDLE    registryConfigHandle,
    PMADGE_ADAPTER ndisAdap,
    ULONG          adapterType
    )
{
    NDIS_STATUS                    status;
    PNDIS_CONFIGURATION_PARAMETER  configParam;

    //
    // Note the information that is always TRUE for ISA adapters.
    //

    ndisAdap->NTCardBusType = NdisInterfaceIsa;

    //
    // Do some adapter type specific setup. If we don't
    // know what sort of adapter it is we'll assume it's
    // an ATULA adapter so we are backwards compatible.
    //

    switch (adapterType)
    {
        case MADGE_ADAPTER_UNKNOWN:
        case MADGE_ADAPTER_ATULA: 
                
            ndisAdap->FTKCardBusType = ADAPTER_CARD_ATULA_BUS_TYPE;
            ndisAdap->IORange1       = ATULA_IO_RANGE;
            ndisAdap->TransferMode   = DMA_DATA_TRANSFER_MODE;
            break;

        case MADGE_ADAPTER_SMART16:
                
            ndisAdap->FTKCardBusType = ADAPTER_CARD_SMART16_BUS_TYPE;
            ndisAdap->IORange1       = SMART16_IO_RANGE;
            ndisAdap->TransferMode   = PIO_DATA_TRANSFER_MODE;
            break;

        case MADGE_ADAPTER_PCMCIA: 
                
            ndisAdap->FTKCardBusType = ADAPTER_CARD_PCMCIA_BUS_TYPE;
            ndisAdap->IORange1       = PCMCIA_IO_RANGE;
            ndisAdap->TransferMode   = PIO_DATA_TRANSFER_MODE;
            break;

        case MADGE_ADAPTER_PNP:

            ndisAdap->FTKCardBusType = ADAPTER_CARD_PNP_BUS_TYPE;
            ndisAdap->IORange1       = PNP_IO_RANGE;
            ndisAdap->TransferMode   = PIO_DATA_TRANSFER_MODE;
            break;

        default:

            return NDIS_STATUS_FAILURE;
    }

    //
    // Get the IO location - must have this. First try 
    // "IoLocation" and then "IoBaseAddress".
    //

    NdisReadConfiguration(
    	&status,
    	&configParam,
    	registryConfigHandle,
    	&IOAddressString,
    	NdisParameterHexInteger
    	);

    if (status != NDIS_STATUS_SUCCESS)
    {
        NdisReadConfiguration(
     	    &status,
     	    &configParam,
     	    registryConfigHandle,
     	    &IOBaseAddrString,
     	    NdisParameterHexInteger
     	    );
    }

    if (status != NDIS_STATUS_SUCCESS)
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_MISSING_CONFIGURATION_PARAMETER,
            2,
            readRegistry,
            MADGE_ERRMSG_NO_ISA_IO
            );

	return status;
    }

    ndisAdap->IoLocation1 = configParam->ParameterData.IntegerData;

    //
    // Er, slight hack here. We used to pretend that Smart16 
    // adapters were ATULA adapters. We now don't. So to
    // be backwards compatible, if we have an unknown adapter
    // with an IO base >= 0x4a20 and <= 0x6e20 we'll assume it's
    // really a Smart16.
    //

    if (adapterType           == MADGE_ADAPTER_UNKNOWN &&
        ndisAdap->IoLocation1 >= 0x4a20                &&
        ndisAdap->IoLocation1 <= 0x6e20)
    {
        adapterType              = MADGE_ADAPTER_SMART16;
        ndisAdap->FTKCardBusType = ADAPTER_CARD_SMART16_BUS_TYPE;
        ndisAdap->IORange1       = SMART16_IO_RANGE;
        ndisAdap->TransferMode   = PIO_DATA_TRANSFER_MODE;
    }

    //
    // Get the IRQ number - we must have this.
    //

    NdisReadConfiguration(
    	&status,
    	&configParam,
    	registryConfigHandle,
    	&InterruptNumberString,
    	NdisParameterInteger
    	);

    if (status != NDIS_STATUS_SUCCESS)
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_MISSING_CONFIGURATION_PARAMETER,
            2,
            readRegistry,
            MADGE_ERRMSG_NO_ISA_IRQ
            );

	return status;
    }

    ndisAdap->UsedInISR.InterruptNumber = 
        configParam->ParameterData.IntegerData;

    ndisAdap->UsedInISR.InterruptMode   = NdisInterruptLatched;
    ndisAdap->UsedInISR.InterruptShared = FALSE;

    //
    // Read the TransferType parameter and switch into PIO
    // mode if specified.
    //

    NdisReadConfiguration(
    	&status,
    	&configParam,
    	registryConfigHandle,
    	&TransferModeString,
    	NdisParameterInteger
    	);

    if (status == NDIS_STATUS_SUCCESS)
    {
        if (configParam->ParameterData.IntegerData == MADGE_PIO_MODE)
        {
            ndisAdap->TransferMode = PIO_DATA_TRANSFER_MODE;
        }
    }

    //
    // Get the DMA channel (PIO is specified as channel 0,
    // multiprocessor safe PIO is specified as 0x8000). We
    // don't need a DMA channel if the adapter isn't an ATULA so
    // the only reason for reading the DMA channel for none
    // ATULA adapters is to allow backwards compatability with old 
    // registry set ups that specify multiprocessor safe PIO
    // with the DmaChannel == 0x8000. Using the DMA channel
    // to specify PIO is retained for backwards compatibility
    // the correct way is to set the TransferType parameter.
    //

    NdisReadConfiguration(
        &status,
        &configParam,
        registryConfigHandle,
        &DMAChannelString,
        NdisParameterInteger
        );

    if (status != NDIS_STATUS_SUCCESS)
    {
        ndisAdap->DmaChannel = 0;
    }
    else
    {
        ndisAdap->DmaChannel = configParam->ParameterData.IntegerData;
    }

    //
    // Note if we should be using multiprocessor safe PIO.
    //

    if (ndisAdap->DmaChannel == 0x8000)
    {
         ndisAdap->DmaChannel   = 0;
         ndisAdap->UseMPSafePIO = TRUE;
    }

    //
    // If we did not get a DMA channel then we must use PIO.
    //

    if (ndisAdap->DmaChannel == 0)
    {
        ndisAdap->TransferMode = PIO_DATA_TRANSFER_MODE;
    }

    return NDIS_STATUS_SUCCESS;
}


/*---------------------------------------------------------------------------
|
| Function    - MadgeFindPciInfoForWin95
|
| Parameters  - wrapperConfigHandle  -> Wrapper context handle.
|               registryConfigHandle -> Already open registry query handle.
|               ndisAdap             -> Pointer to an NDIS3 level adapter
|                                       structure.
Ý               pciSlotInfo          -> Pointer to a buffer that will
Ý                                       be filled with the configuration 
Ý                                       data for the adapter.
|
| Purpose     - Read configuration information for PCI adapters out 
Ý               of the registry when running on Windows95. The slot
Ý               containing the adapter is also found and the configuration
Ý               data from the slot returned in the pciSlotInfo buffer.
|
| Returns     - An NDIS3 status code.
|
|--------------------------------------------------------------------------*/

STATIC NDIS_STATUS
MadgeFindPciInfoForWin95(
    NDIS_HANDLE      wrapperConfigHandle,
    NDIS_HANDLE      registryConfigHandle,
    PMADGE_ADAPTER   ndisAdap,
    BYTE           * pciSlotInfo
    );

#pragma FTK_INIT_FUNCTION(MadgeFindPciInfoForWin95)

STATIC NDIS_STATUS
MadgeFindPciInfoForWin95(
    NDIS_HANDLE      wrapperConfigHandle,
    NDIS_HANDLE      registryConfigHandle,
    PMADGE_ADAPTER   ndisAdap,
    BYTE           * pciSlotInfo

    )
{
    NDIS_STATUS                   status;
    PNDIS_CONFIGURATION_PARAMETER configParam;
    UINT                          i;

    //
    // Unfortunately Windows95 (M7) and NT handle PCI configuration
    // in different ways. Under NT one has to read the slot
    // configuration. Under Windows95 the resource information
    // is faked up by the configuration manager and can be read 
    // directly from the wrapper.
    //

    //
    // Get the IO location - must have this. First try 
    // "IoLocation" and then "IoBaseAddress".
    //

    NdisReadConfiguration(
        &status,
	&configParam,
	registryConfigHandle,
	&IOAddressString,
	NdisParameterHexInteger
	);

    if (status != NDIS_STATUS_SUCCESS)
    {
        NdisReadConfiguration(
    	    &status,
    	    &configParam,
    	    registryConfigHandle,
    	    &IOBaseAddrString,
    	    NdisParameterHexInteger
    	    );
    }
                
    if (status != NDIS_STATUS_SUCCESS)
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_MISSING_CONFIGURATION_PARAMETER,
            2,
            readRegistry,
            MADGE_ERRMSG_NO_PCI_IO
            );

	return status;
    }

    ndisAdap->IoLocation1 = configParam->ParameterData.IntegerData;

    //
    // Get the IRQ number - we must have this.
    //

    NdisReadConfiguration(
    	&status,
    	&configParam,
    	registryConfigHandle,
    	&InterruptNumberString,
    	NdisParameterInteger
    	);

    if (status != NDIS_STATUS_SUCCESS)
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_MISSING_CONFIGURATION_PARAMETER,
            2,
            readRegistry,
            MADGE_ERRMSG_NO_PCI_IRQ
            );

	return status;
    }

    ndisAdap->UsedInISR.InterruptNumber = 
        configParam->ParameterData.IntegerData;

    //
    // Get the MMIO base address - optional. 
    //

    NdisReadConfiguration(
        &status,
        &configParam,
        registryConfigHandle,
        &MmioAddressString,
        NdisParameterInteger
        );

    if (status == NDIS_STATUS_SUCCESS)
    {
        ndisAdap->MmioRawAddress = 
            configParam->ParameterData.IntegerData;
    }

    //
    // We also need to know which slot the adapter is in so we can
    // read and write configuration space directly. We'll search for
    // a slot which contains a Madge adapter which the correct I/O
    // location. As a side effect we'll store the configuration data 
    // for the slot in pciSlotInfo. Note: Under Windows 95 (build 490)
    // NdisReadPciSlotInformation does appear to return the number
    // of bytes read as it does under NT - not sure what it returns ...
    //

    ndisAdap->SlotNumber = PCI_FIND_ADAPTER;

    for (i = 0; i < MAX_PCI_SLOTS; i++)
    {
        NdisReadPciSlotInformation(
            ndisAdap->UsedInISR.MiniportHandle,
            i,
            0,
            (VOID *) pciSlotInfo,
            PCI_CONFIG_SIZE
            );

        if (PCI_VENDOR_ID(pciSlotInfo) == MADGE_PCI_VENDOR_ID &&
            PCI_IO_BASE(pciSlotInfo)   == ndisAdap->IoLocation1)
        {
            ndisAdap->SlotNumber = i;
            break;
        }
    }

    if (ndisAdap->SlotNumber == PCI_FIND_ADAPTER)
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_DRIVER_FAILURE,
            2,
            readRegistry,
            MADGE_ERRMSG_BAD_PCI_SLOTNUMBER
            );

        return NDIS_STATUS_FAILURE;
    }
    
    return NDIS_STATUS_SUCCESS;
}


/*---------------------------------------------------------------------------
Ý
Ý Function    - MadgePciSlotUsed
Ý
Ý Parameters  - busNumber  -> Bus number containing the adapter.
Ý               slotNumber -> Slot number containing the adapter.
Ý 
Ý Purpose     - Check if a PCI slot is already in use.
Ý
Ý Returns     - TRUE if the slot is in use or FALSE if not.
Ý
Ý--------------------------------------------------------------------------*/

STATIC BOOLEAN
MadgePciSlotUsed(
    UINT busNumber,
    UINT slotNumber
    );

#pragma FTK_INIT_FUNCTION(MadgePciSlotUsed)

STATIC BOOLEAN
MadgePciSlotUsed(
    UINT busNumber,
    UINT slotNumber
    )
{
    int i;

    for (i = 0; i < PciSlotsUsedCount; i++)
    {
        if (PciSlotsUsedList[i].BusNumber  == busNumber &&
            PciSlotsUsedList[i].SlotNumber == slotNumber)
        {
            return TRUE;
        }
    }

    return FALSE;
}


/*---------------------------------------------------------------------------
|
| Function    - MadgeFindPciInfoForNt
|
| Parameters  - wrapperConfigHandle  -> Wrapper context handle.
|               registryConfigHandle -> Already open registry query handle.
|               ndisAdap             -> Pointer to an NDIS3 level adapter
|                                       structure.
Ý               pciSlotInfo          -> Pointer to a buffer that will
Ý                                       be filled with the configuration 
Ý                                       data for the adapter.
|
| Purpose     - Read configuration information for PCI adapters out 
Ý               of the registry when running on Windows95. The slot
Ý               containing the adapter is also found and the configuration
Ý               data from the slot returned in the pciSlotInfo buffer.
|
| Returns     - An NDIS3 status code.
|
|--------------------------------------------------------------------------*/

STATIC NDIS_STATUS
MadgeFindPciInfoForNt(
    NDIS_HANDLE      wrapperConfigHandle,
    NDIS_HANDLE      registryConfigHandle,
    PMADGE_ADAPTER   ndisAdap,
    BYTE           * pciSlotInfo
    );

#pragma FTK_INIT_FUNCTION(MadgeFindPciInfoForNt)

STATIC NDIS_STATUS
MadgeFindPciInfoForNt(
    NDIS_HANDLE      wrapperConfigHandle,
    NDIS_HANDLE      registryConfigHandle,
    PMADGE_ADAPTER   ndisAdap,
    BYTE           * pciSlotInfo
    )
{
    NDIS_STATUS                     status;
    PNDIS_CONFIGURATION_PARAMETER   configParam;
    UINT                            slotNumber;
    BOOLEAN                         pciSlotRead;
    BOOLEAN                         useMmio;
    UINT                            i;
    PNDIS_RESOURCE_LIST             pciResources;
    PCM_PARTIAL_RESOURCE_DESCRIPTOR resDesc;
    UINT                            busNumber;

    //
    // Unfortunately Windows95 (M7) and NT handle PCI configuration
    // in different ways. Under NT one has to read the slot
    // configuration. Under Windows95 the resource information
    // is faked up by the configuration manager and can be read 
    // directly from the wrapper. 
    //
     
    //
    // Find out what the slot number is. This is in fact the
    // PCI device number. Values 0 through 31 represent real
    // slot numbers. 0xffff means we should search for the
    // first unused Madge PCI adapter.
    //

    NdisReadConfiguration(
    	&status,
    	&configParam,
    	registryConfigHandle,
    	&SlotNumberString,
    	NdisParameterInteger
    	);

    if (status != NDIS_STATUS_SUCCESS)
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_MISSING_CONFIGURATION_PARAMETER,
            2,
            readRegistry,
            MADGE_ERRMSG_NO_PCI_SLOTNUMBER
            );

	return status;
    }

    slotNumber  = configParam->ParameterData.IntegerData;
    pciSlotRead = FALSE;

    //
    // Read the bus number.
    //

    NdisReadConfiguration(
    	&status,
    	&configParam,
    	registryConfigHandle,
    	&BusNumberString,
    	NdisParameterInteger
    	);

    if (status != NDIS_STATUS_SUCCESS)
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_MISSING_CONFIGURATION_PARAMETER,
            2,
            readRegistry,
            MADGE_ERRMSG_NO_PCI_SLOTNUMBER
            );

	return status;
    }

    busNumber = configParam->ParameterData.IntegerData;

    //
    // If the slot number is PCI_FIND_ADAPTER (0xffff) then we 
    // will attempt to search for the first Madge PCI adapter 
    // that is not already in use.
    //

    if (slotNumber == PCI_FIND_ADAPTER)
    {
        for (i = 0; !pciSlotRead && i < MAX_PCI_SLOTS; i++)
        {
            if (!MadgePciSlotUsed(busNumber, i))
            {
                //
                // Extract the PCI configuration information from 
                // the slot.
                //

                status = NdisReadPciSlotInformation(
                             ndisAdap->UsedInISR.MiniportHandle,
                             i,
                             0,
                             (VOID *) pciSlotInfo,
                             PCI_CONFIG_SIZE
                             );
                //
                // Check if the slot contains a Madge adapter and 
                // break out of the loop if it does.
                //

                if (status                     == PCI_CONFIG_SIZE && 
                    PCI_VENDOR_ID(pciSlotInfo) == MADGE_PCI_VENDOR_ID)
                {
                    slotNumber  = i;
                    pciSlotRead = TRUE;
                }
            }
        }
    }

    //
    // Check if the slotNumber is valid. This will fail if the
    // above adapter search failed.
    //

    if (slotNumber <  0             || 
        slotNumber >= MAX_PCI_SLOTS || 
        MadgePciSlotUsed(busNumber, slotNumber))
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_DRIVER_FAILURE,
            2,
            readRegistry,
            MADGE_ERRMSG_BAD_PCI_SLOTNUMBER
            );

        return NDIS_STATUS_FAILURE;
    }
                
    //
    // Note that the PCI slot is in use.
    //

    PciSlotsUsedList[PciSlotsUsedCount].BusNumber  = busNumber;
    PciSlotsUsedList[PciSlotsUsedCount].SlotNumber = slotNumber;
    PciSlotsUsedCount++;

    ndisAdap->SlotNumber = slotNumber;

    //
    // There two methods for getting the PCI configuration. One is
    // to read it directly from the PCI configuration space. This
    // works for Intel patforms where a PCI BIOS has configured
    // all of the adapters at boot time. It does not work for
    // none Intel platforms where the PCI devices are not
    // configured at boot time. Unfortunately the call which
    // provokes NT to configure a PCI device, NdisMPciAssignResources
    // is not available in the NT 3.5 wrapper. So, until NT 3.51
    // becomes dominant we must support both configuration methods.
    //

    //
    // If we haven't already extracted the PCI configuration 
    // information from the slot and check that it is valid.
    //

    if (!pciSlotRead)
    {
        status = NdisReadPciSlotInformation(
                     ndisAdap->UsedInISR.MiniportHandle,
                     slotNumber,
                     0,
                     (VOID *) pciSlotInfo,
                     PCI_CONFIG_SIZE
                     );

        if (status                     != PCI_CONFIG_SIZE || 
            PCI_VENDOR_ID(pciSlotInfo) != MADGE_PCI_VENDOR_ID)
        {
            MadgePrint1("No Madge adapter in slot\n");

            NdisWriteErrorLogEntry(
                ndisAdap->UsedInISR.MiniportHandle,
                NDIS_ERROR_CODE_DRIVER_FAILURE,
                2,
                readRegistry,
                MADGE_ERRMSG_BAD_PCI_SLOTNUMBER
                );

            return NDIS_STATUS_FAILURE;
        }
    }

    //
    // Call NdisMPciAssignResources for the specified slot to
    // get the adapter configuration.
    //

    status = NdisMPciAssignResources(
                 ndisAdap->UsedInISR.MiniportHandle,
                 slotNumber,
                 &pciResources
                 );

    if (status != NDIS_STATUS_SUCCESS)
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_DRIVER_FAILURE,
            2,
            readRegistry,
            MADGE_ERRMSG_BAD_PCI_SLOTNUMBER
            );

        return NDIS_STATUS_FAILURE;
    }

    //
    // Iterate through the returned resource list recording the values
    // in the PCI configuration
    //

    for (i = 0; i < pciResources->Count; i++) 
    {
        resDesc = &pciResources->PartialDescriptors[i];

        switch (resDesc->Type) 
        {
	    case CmResourceTypeInterrupt:
  
                ndisAdap->UsedInISR.InterruptNumber =
                    (ULONG) resDesc->u.Interrupt.Vector;
		break;

	    case CmResourceTypePort: 

		ndisAdap->IoLocation1 = 
                    (UINT) NdisGetPhysicalAddressLow(resDesc->u.Port.Start);
		break;

            case CmResourceTypeMemory:

		ndisAdap->MmioRawAddress = 
                    (DWORD) NdisGetPhysicalAddressLow(resDesc->u.Memory.Start);
		break;
        }
    }           


    //
    // On none-Intel platforms it's possible for the PCI adapter's I/O
    // base to be greater than 0xffff. Since the FTK uses 16bit
    // I/O locations we make a note of the I/O base in a 32bit cell
    // that we can add in inside the I/O functions in sys_mem.c
    // 

#ifndef _M_IX86

    ndisAdap->IoLocationBase = ndisAdap->IoLocation1;
    ndisAdap->IoLocation1    = 0;

#endif

    return NDIS_STATUS_SUCCESS;
}


/*---------------------------------------------------------------------------
|
| Function    - MadgeReadRegistryForPCI
|
| Parameters  - wrapperConfigHandle  -> Wrapper context handle.
|               registryConfigHandle -> Already open registry query handle.
|               ndisAdap             -> Pointer to an NDIS3 level adapter
|                                       structure.
Ý               platformType         -> Type of platform: NT or Win95.
|
| Purpose     - Read configuration information for PCI.
|
| Returns     - An NDIS3 status code.
|
|--------------------------------------------------------------------------*/

STATIC NDIS_STATUS
MadgeReadRegistryForPCI(
    NDIS_HANDLE    wrapperConfigHandle,
    NDIS_HANDLE    registryConfigHandle,
    PMADGE_ADAPTER ndisAdap,
    UINT           platformType
    );

#pragma FTK_INIT_FUNCTION(MadgeReadRegistryForPCI)

STATIC NDIS_STATUS
MadgeReadRegistryForPCI(
    NDIS_HANDLE    wrapperConfigHandle,
    NDIS_HANDLE    registryConfigHandle,
    PMADGE_ADAPTER ndisAdap,
    UINT           platformType
    )
{
    NDIS_STATUS                     status;
    PNDIS_CONFIGURATION_PARAMETER   configParam;
    BYTE                            pciSlotInfo[PCI_CONFIG_SIZE];
    BOOLEAN                         useMmio;

    //
    // Note the information that is always true for PCI adapters.
    //

    ndisAdap->NTCardBusType  = NdisInterfacePci;

    //
    // Set up the fixed configuration information.
    //

    ndisAdap->UsedInISR.InterruptMode   = NdisInterruptLevelSensitive;
    ndisAdap->UsedInISR.InterruptShared = TRUE;

    //
    // We know need to find the PCI adapter and read in the configuration
    // information for the slot. Unfortunatetly the method we have to use
    // is different for NT and Win95.
    //

    if (platformType == MADGE_OS_WIN95)
    {
        status = MadgeFindPciInfoForWin95(
                     wrapperConfigHandle,
                     registryConfigHandle,
                     ndisAdap,
                     pciSlotInfo
                     );
    }
    else
    {
        status = MadgeFindPciInfoForNt(
                     wrapperConfigHandle,
                     registryConfigHandle,
                     ndisAdap,
                     pciSlotInfo
                     );
    }

    if (status != NDIS_STATUS_SUCCESS)
    {
        return status;
    }

    //
    // Now we know we have a Madge PCI adapter of some sort but
    // as yet we don't know what type. We'll work this out by
    // looking at the device/revision ID in the slot's configuration
    // data. At the same time we'll note the default transfer type
    // for the adapter.
    //

    switch (PCI_REVISION(pciSlotInfo))
    {
        case MADGE_PCI_RAP1B_REVISION:

            ndisAdap->FTKCardBusType = ADAPTER_CARD_PCI_BUS_TYPE;
            ndisAdap->TransferMode   = MMIO_DATA_TRANSFER_MODE;
            ndisAdap->IORange1       = PCI_IO_RANGE;
            break;

        case MADGE_PCI_PCI2_REVISION:

            ndisAdap->FTKCardBusType = ADAPTER_CARD_PCI2_BUS_TYPE;
            ndisAdap->TransferMode   = DMA_DATA_TRANSFER_MODE;
            ndisAdap->IORange1       = PCI2_IO_RANGE;
            break;

        case MADGE_PCI_PCIT_REVISION:

            ndisAdap->FTKCardBusType = ADAPTER_CARD_TI_PCI_BUS_TYPE;
            ndisAdap->TransferMode   = DMA_DATA_TRANSFER_MODE;
            ndisAdap->IORange1       = SIF_IO_RANGE;
            break;

        default:

            return NDIS_STATUS_FAILURE;
    }

    //
    // Now we need to work out the transfer type. There are three
    // things that affect the transfer type: the setting of
    // the TransferType registry parameter, the setting of the
    // NoMmio registry flag and whether we have been allocated any
    // MMIO memory. Ideally we would just use the TransferType flag.
    // The NoMmio flag is to preserve backwards compatibility with old
    // registry set ups.
    //

    //
    // Read the transfer type flag if possible.
    //

    NdisReadConfiguration(
    	&status,
    	&configParam,
    	registryConfigHandle,
    	&TransferModeString,
    	NdisParameterInteger
    	);

    if (status == NDIS_STATUS_SUCCESS)
    {
        //
        // Set the transfer type depending on the TransferType parameter
        // and the adapter type.
        //

        if (configParam->ParameterData.IntegerData == MADGE_DMA_MODE)
        {
            if (ndisAdap->FTKCardBusType == ADAPTER_CARD_PCI2_BUS_TYPE ||
                ndisAdap->FTKCardBusType == ADAPTER_CARD_TI_PCI_BUS_TYPE)
            {
                ndisAdap->TransferMode = DMA_DATA_TRANSFER_MODE;
            }
        }

        if (configParam->ParameterData.IntegerData == MADGE_PIO_MODE)
        {
            ndisAdap->TransferMode = PIO_DATA_TRANSFER_MODE;
        }

        if (configParam->ParameterData.IntegerData == MADGE_MMIO_MODE)
        {
            if (ndisAdap->FTKCardBusType == ADAPTER_CARD_PCI_BUS_TYPE)
            {
                ndisAdap->TransferMode = MMIO_DATA_TRANSFER_MODE;
            }
        }
    }

    //
    // To preserve backwards compatibility if we find the NoMmio flag
    // set then switch to PIO mode.
    //

    if (ndisAdap->TransferMode == MMIO_DATA_TRANSFER_MODE)
    {
        NdisReadConfiguration(
    	    &status,
    	    &configParam,
    	    registryConfigHandle,
    	    &NoMmioString,
    	    NdisParameterInteger
    	    );

        if (status == NDIS_STATUS_SUCCESS)
        {
            if (configParam->ParameterData.IntegerData != 0)
            {
                ndisAdap->TransferMode = PIO_DATA_TRANSFER_MODE;
            }
        }
    }

    //
    // If we are in MMIO mode then check that we were allocated some MMIO
    // memory. If not switch to PIO mode.
    //

    if (ndisAdap->TransferMode == MMIO_DATA_TRANSFER_MODE)
    {
        if (ndisAdap->MmioRawAddress == 0)
        {
            NdisWriteErrorLogEntry(
                ndisAdap->UsedInISR.MiniportHandle,
                NDIS_ERROR_CODE_MEMORY_CONFLICT,
                2,
                readRegistry,
                MADGE_ERRMSG_BAD_PCI_MMIO
                );

            ndisAdap->TransferMode == PIO_DATA_TRANSFER_MODE;

        }    
    }

    return NDIS_STATUS_SUCCESS;
}


/*---------------------------------------------------------------------------
|
| Function    - MadgeReadRegistry
|
| Parameters  - wrapperConfigHandle  -> Wrapper context handle.
|               registryConfigHandle -> Already open registry query handle.
|               ndisAdap             -> Pointer to an NDIS3 level adapter
|                                       structure.
|
| Purpose     - Read configuration information out of the registry.
|
| Returns     - An NDIS3 status code.
|
|--------------------------------------------------------------------------*/

STATIC NDIS_STATUS
MadgeReadRegistry(
    NDIS_HANDLE    wrapperConfigHandle,
    NDIS_HANDLE    registryConfigHandle,
    PMADGE_ADAPTER ndisAdap
    );

#pragma FTK_INIT_FUNCTION(MadgeReadRegistry)

STATIC NDIS_STATUS
MadgeReadRegistry(
    NDIS_HANDLE    wrapperConfigHandle,
    NDIS_HANDLE    registryConfigHandle,
    PMADGE_ADAPTER ndisAdap
    )
{
    NDIS_STATUS                     status;
    PNDIS_CONFIGURATION_PARAMETER   configParam;
    MADGE_PARM_DEFINITION         * pMadgeParmTable;
    PVOID                           networkAddress;
    ULONG                           networkAddressLength;
    UINT                            adapterType;
    UINT                            platformType;

    //
    // Try to read the OS platform type. If we don't find one then 
    // assume we are running on NT.
    //

    NdisReadConfiguration(
	&status,
	&configParam,
	registryConfigHandle,
	&PlatformString,
	NdisParameterInteger
	);

    if (status != NDIS_STATUS_SUCCESS)
    {
        platformType = MADGE_OS_NT;
    }
    else
    {
        platformType = configParam->ParameterData.IntegerData;
    }

    //
    // Read the system bus type - that will give us a direction
    // in which to search for further details.
    //

    NdisReadConfiguration(
	&status,
	&configParam,
	registryConfigHandle,
	&BusTypeString,
	NdisParameterInteger
	);

    if (status != NDIS_STATUS_SUCCESS)
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_MISSING_CONFIGURATION_PARAMETER,
            2,
            readRegistry,
            MADGE_ERRMSG_NO_BUS_TYPE
            );

	return status;
    }

    ndisAdap->BusType = configParam->ParameterData.IntegerData;

    //
    // Originally we determined what sort of adapter we had based
    // on the bus type returned by the configuration call to the
    // wrapper. This works for NT but doesn't for Windows95 (M7)
    // which seems to fail to identify a card as being in a PCI
    // bus. We also cannot tell between the various sorts of ISA
    // adapter now available. To fix this we look in the registry 
    // for an adapter type parameter. We use this and the bus type
    // returned by the wrapper to work out where to start. We don't
    // fail if we can't read an adapter type so that we will work with
    // old registry set ups.
    //
    // Build 310 of Windows95 seems to return the native bus type of the 
    // PC. This means on a PCI machine we always get NdisInterfacePci.
    // To get around this problem we will work out the bus type from 
    // the adapter type parameter if one is present.
    //
    // Unfortunately we can't just abandon the bus type de-multiplexing
    // if we are to work with old NT registry set ups.
    //

    NdisReadConfiguration(
	&status,
	&configParam,
	registryConfigHandle,
	&AdapterString,
	NdisParameterInteger
	);

    if (status != NDIS_STATUS_SUCCESS)
    {
        adapterType = MADGE_ADAPTER_UNKNOWN;
    }
    else
    {
        adapterType = configParam->ParameterData.IntegerData;
    }

    switch (adapterType)
    {
        case MADGE_ADAPTER_ATULA:
        case MADGE_ADAPTER_PCMCIA:
        case MADGE_ADAPTER_PNP:
        case MADGE_ADAPTER_SMART16:

            ndisAdap->BusType = NdisInterfaceIsa;
            break;

        case MADGE_ADAPTER_EISA:

            ndisAdap->BusType = NdisInterfaceEisa;
            break;

        case MADGE_ADAPTER_MC:

            ndisAdap->BusType = NdisInterfaceMca;
            break;

        case MADGE_ADAPTER_PCI:

            ndisAdap->BusType = NdisInterfacePci;
            break;

        default:

            //
            // We don't have a valid adapter type parameter so we'll
            // just have to beleive the bus type the wrapper passed
            // us.
            //

            break;
    }

    //
    // Based on the determined Bus Type, try to find details of the card.
    //

    //
    // Remember, all fields of the MADGE_ADAPTER structure were zeroed
    // after the structure's allocation.
    //

    switch (ndisAdap->BusType)
    {
	case NdisInterfaceMca:

            status = MadgeReadRegistryForMC(
                         wrapperConfigHandle,
                         registryConfigHandle,
                         ndisAdap
                         );

	    if (status != NDIS_STATUS_SUCCESS)
	    {
		return status;
	    }

	    break;

	case NdisInterfaceEisa:

            //
	    // For Eisa bus systems, we could have an Isa card or an Eisa
	    // card - try to read the Eisa information, and if that fails
	    // assume it is an Isa card instead.
            //

            status = MadgeReadRegistryForEISA(
                         wrapperConfigHandle,
                         registryConfigHandle,
                         ndisAdap
                         );

            if (status == NDIS_STATUS_SUCCESS)
            {
                break;
            }

            //
	    // Failed to read EISA data for this card, so it is unlikely 
	    // to be one - try ISA instead - fall through.
            //

	case NdisInterfaceIsa:

            status = MadgeReadRegistryForISA(
                         wrapperConfigHandle,
                         registryConfigHandle,
                         ndisAdap,
                         adapterType
                         );

	    if (status != NDIS_STATUS_SUCCESS)
	    {
		return status;
	    }

	    break;

        case NdisInterfacePci:

            status = MadgeReadRegistryForPCI(
                         wrapperConfigHandle,
                         registryConfigHandle,
                         ndisAdap,
                         platformType
                         );

	    if (status != NDIS_STATUS_SUCCESS)
	    {
		return status;
	    }

	    break;


	default:

            //
	    // Unsupported Bus Type, so return failure - no point being more 
	    // explicit than that at the moment since any of the bits above  
	    // could have failed too, and they do not return anything more
	    // meaningful either. 
            //

	    return NDIS_STATUS_FAILURE;
    }

    MadgePrint2("FTKCardBusType  = %d\n", ndisAdap->FTKCardBusType);
    MadgePrint2("SlotNumber      = %d\n", ndisAdap->SlotNumber);
    MadgePrint2("IoLocation1     = %lx\n", ndisAdap->IoLocation1);
    MadgePrint2("MmioAddress     = %lx\n", ndisAdap->MmioRawAddress);
    MadgePrint2("InterruptNumber = %lx\n", ndisAdap->UsedInISR.InterruptNumber);
    MadgePrint2("TransferMode    = %d\n", ndisAdap->TransferMode);
    MadgePrint2("DmaChannel      = %d\n", ndisAdap->DmaChannel);

    //
    // To get here, we must have worked out the IO Address, IRQ number, DMA
    // channel/arbitration level, and all the interrupt details. This just
    // leaves the optional parameters for tuning the performance of the MAC
    // code.
    //

    pMadgeParmTable = (MADGE_PARM_DEFINITION *) &MadgeParmTable;

    while (!NdisEqualString(&pMadgeParmTable->Keyword, &NullString, TRUE))
    {
	NdisReadConfiguration(
	    &status,
	    &configParam,
	    registryConfigHandle,
	    &pMadgeParmTable->Keyword,
	    pMadgeParmTable->DefaultValue.ParameterType
	    );

	if (status == NDIS_STATUS_SUCCESS)
	{
            //
	    // Did read something. Check bounds. We assume all are Integers.
            //

	    if (configParam->ParameterData.IntegerData < 
                    pMadgeParmTable->Minimum ||
		configParam->ParameterData.IntegerData > 
                    pMadgeParmTable->Maximum)
            {
                NdisWriteErrorLogEntry(
                    ndisAdap->UsedInISR.MiniportHandle,
                    NDIS_ERROR_CODE_DRIVER_FAILURE,
                    2,
                    readRegistry,
                    MADGE_ERRMSG_BAD_PARAMETER
                    );

	        pMadgeParmTable->ActualValue = pMadgeParmTable->DefaultValue;
            }
            else
            {
	        pMadgeParmTable->ActualValue = *configParam;
            }
	}
	else
	{
            //
	    // We didn't read anything, so use the default value.
            //

	    pMadgeParmTable->ActualValue = pMadgeParmTable->DefaultValue;
	}

	pMadgeParmTable++;
    }
      
    //                                                    
    // We have successfully read any optional keywords and none of them is 
    // too small or big. The other thing we need the registry for is the 
    // locally administered address, for which there is a specific NDIS call
    //

    NdisReadNetworkAddress( 
        &status,
	&networkAddress,
	&networkAddressLength,
	registryConfigHandle
        );

    if (status               == NDIS_STATUS_SUCCESS &&
	networkAddressLength == TR_LENGTH_OF_ADDRESS)
    {
        //
	// We read a valid length TR address, but if the
	// top two bits are not "01", it is not legal.
        //

	if ((((BYTE *) networkAddress)[0] & 0xc0) == 0x40)
	{
	    ndisAdap->OpeningNodeAddress =
                *((NODE_ADDRESS *) networkAddress);
	}
    }

    return NDIS_STATUS_SUCCESS;
}


/****************************************************************************
*
* Function    - MadgeShutdown
*
* Parameters  - context -> Adapter context.
*
* Purpose     - Quickly shutdown the adapter.
*
* Returns     - Nothing.
*
****************************************************************************/

VOID
MadgeShutdown(
    NDIS_HANDLE context
    )
{
    MADGE_ADAPTER * ndisAdap;

    ndisAdap = PMADGE_ADAPTER_FROM_CONTEXT(context);

    MadgePrint1("MadgeShutdown called\n");

    if (ndisAdap->TimerInitialized)
    {
        BOOLEAN timerOutstanding;
        
        NdisMCancelTimer(&ndisAdap->WakeUpTimer, &timerOutstanding);
        NdisMCancelTimer(&ndisAdap->CompletionTimer, &timerOutstanding);
        
        ndisAdap->TimerInitialized = FALSE;
    }

    //
    // Just call the FTK to shutdown the adapter.
    //

    if (ndisAdap->FtkInitialized)
    {
        rxtx_await_empty_tx_slots(ndisAdap->FtkAdapterHandle);
        driver_remove_adapter(ndisAdap->FtkAdapterHandle);
        ndisAdap->FtkInitialized = FALSE;
        ndisAdap->AdapterRemoved = TRUE;
    }

    MadgePrint1("MadgeShutdown ended\n");
}


/*---------------------------------------------------------------------------
|
| Function    - MadgeRegisterAdapter
|
| Parameters  - ndisAdap             -> Pointer to an NDIS3 level adapter
|                                       structure.
|               wrapperConfigHandle  -> Wrapper context handle.
|
| Purpose     - Register an adapter instance with the NDIS3 wrapper.
|
| Returns     - An NDIS3 status code.
|
|--------------------------------------------------------------------------*/

STATIC NDIS_STATUS
MadgeRegisterAdapter(
    PMADGE_ADAPTER ndisAdap,
    NDIS_HANDLE    wrapperConfigHandle
    );

#pragma FTK_INIT_FUNCTION(MadgeRegisterAdapter)

STATIC NDIS_STATUS
MadgeRegisterAdapter(
    PMADGE_ADAPTER ndisAdap,
    NDIS_HANDLE    wrapperConfigHandle
    )
{
    NDIS_STATUS status;
    BOOLEAN     busMaster;

    MadgePrint1("MadgeRegisterAdapter started\n");

    //
    // Register a shutdown handler with the wrapper.
    //

    NdisMRegisterAdapterShutdownHandler(
        ndisAdap->UsedInISR.MiniportHandle,
        ndisAdap,
        MadgeShutdown
        );

    ndisAdap->ShutdownHandlerRegistered = TRUE;

    //
    // Register our attributes with the wrapper. These are our adapter
    // context (i.e. a pointer to our adapter structure), whether we
    // are a bus master device and our bus type.
    //

    busMaster = (ndisAdap->TransferMode == DMA_DATA_TRANSFER_MODE);

    MadgePrint1("NdisMSetAttributes called\n");
    MadgePrint2("busMaster = %d\n", (UINT) busMaster);

    NdisMSetAttributes(
        ndisAdap->UsedInISR.MiniportHandle,
        (NDIS_HANDLE) ndisAdap,
        busMaster,
        ndisAdap->NTCardBusType
        );

    MadgePrint1("NdisMSetAttributes returned\n");

    //
    // Register our IO port usage. 
    //

    MadgePrint1("NdisMRegisterIoPortRange called\n");

    status = NdisMRegisterIoPortRange(
                 &ndisAdap->MappedIOLocation1,
                 ndisAdap->UsedInISR.MiniportHandle,
                 ndisAdap->IoLocation1 + ndisAdap->IoLocationBase,
                 ndisAdap->IORange1
                 );

    MadgePrint1("NdisMRegisterIoPortRange returned\n");
    MadgePrint2("MappedIORange1 = %x\n", (UINT) ndisAdap->MappedIOLocation1);

    if (status != NDIS_STATUS_SUCCESS)
    {
        MadgePrint2("NdisMRegisterIoPortRange failed rc = %x\n", status);
        return status;
    }

    ndisAdap->IORange1Initialized = TRUE;

    //
    // If we are using an EISA card then we have a second range of IO
    // locations.
    //

    if (ndisAdap->IORange2 > 0)
    {
        MadgePrint1("NdisMRegisterIoPortRange called\n");

        status = NdisMRegisterIoPortRange(
                     &ndisAdap->MappedIOLocation2,
                     ndisAdap->UsedInISR.MiniportHandle,
                     ndisAdap->IoLocation2 + ndisAdap->IoLocationBase,
                     ndisAdap->IORange2
                     );

        MadgePrint1("NdisMRegisterIoPortRange returned\n");
        MadgePrint2("MappedIORange2 = %x\n", (UINT) ndisAdap->MappedIOLocation2);

        if (status != NDIS_STATUS_SUCCESS)
        {
            MadgePrint2("NdisMRegisterIoPortRange failed rc = %x\n", status);
            return status;
        }

        ndisAdap->IORange2Initialized = TRUE;
    }

    MadgePrint1("MadgeRegisterAdapter finished\n");

    return NDIS_STATUS_SUCCESS;
}


/*---------------------------------------------------------------------------
|
| Function    - FlagIsTrue
|
| Parameters  - flag -> Pointer to a flag to find the value of.
|
| Purpose     - Return the value of a flag. Can be called by a function
Ý               that polls a flag to avoid the compiler optimising out
Ý               the test of the flag.
|
| Returns     - The value of the flag.
|
|--------------------------------------------------------------------------*/

STATIC BOOLEAN
FlagIsTrue(BOOLEAN * flag);

#pragma FTK_INIT_FUNCTION(FlagIsTrue)

STATIC BOOLEAN
FlagIsTrue(BOOLEAN * flag)
{
    MadgePrint1("FlagIsTrue\n");

    return *flag;
}


/*---------------------------------------------------------------------------
|
| Function    - MadgeMapMmioMemory
|
| Parameters  - ndisAdap -> Pointer to an NDIS3 level adapter structure.
|
| Purpose     - Attempt to map in our MMIO memory.
|
| Returns     - An NDIS3 status code.
|
|--------------------------------------------------------------------------*/

STATIC NDIS_STATUS
MadgeMapMmioMemory(PMADGE_ADAPTER ndisAdap);

#pragma FTK_INIT_FUNCTION(MadgeMapMmioMemory)

STATIC NDIS_STATUS
MadgeMapMmioMemory(PMADGE_ADAPTER ndisAdap)
{
    NDIS_PHYSICAL_ADDRESS mmioPhysAddr = NDIS_PHYSICAL_ADDRESS_CONST(0, 0);
    UINT                  status;

    NdisSetPhysicalAddressLow(
        mmioPhysAddr,
        ndisAdap->MmioRawAddress
        );
          
    status = NdisMMapIoSpace(
                 &ndisAdap->MmioVirtualAddress,
                 ndisAdap->UsedInISR.MiniportHandle,
                 mmioPhysAddr,
                 PCI_MMIO_SIZE
                 );

    if (status != NDIS_STATUS_SUCCESS) 
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_MEMORY_CONFLICT,
            2,
            initAdapter,
            MADGE_ERRMSG_MAPPING_PCI_MMIO
            );
    }
    else
    {
        ndisAdap->MmioMapped = TRUE;
    }

    return status;
}


#ifndef LINK_FMPLUS

/*---------------------------------------------------------------------------
|
| Function    - MadgeReadDownload
|
| Parameters  - ndisAdap     -> Pointer to an NDIS3 level adapter structure.
Ý               downloadFile -> Pointer to as handle for the download file.
|               download     -> Pointer to a holder for a pointer to the
Ý                               download image read into memory.
Ý
| Purpose     - Read the download into memory. If the function returns
Ý               success then must unmap and close *downloadFile.
|
| Returns     - An NDIS3 status code.
|
|--------------------------------------------------------------------------*/

STATIC NDIS_STATUS
MadgeReadDownload(
    PMADGE_ADAPTER     ndisAdap,
    NDIS_HANDLE      * downloadFile,
    void           * * download
    );

#pragma FTK_INIT_FUNCTION(MadgeReadDownload)

STATIC NDIS_STATUS
MadgeReadDownload(
    PMADGE_ADAPTER     ndisAdap,
    NDIS_HANDLE      * downloadFile,
    void           * * download
    )
{
    NDIS_STATUS            status;
    NDIS_HANDLE            imageFile;
    UINT                   imageLength;
    PVOID                  imagePtr;
    NDIS_PHYSICAL_ADDRESS  highestAddress = NDIS_PHYSICAL_ADDRESS_CONST(-1, -1);
    DOWNLOAD_FILE_HEADER * downHdrPtr;
    UCHAR                * chkPtr;
    ULONG                  chkSum;
    UINT                   i;

    //
    // Open the FastMAC Plus image file.
    //

    MadgePrint1("NdisOpenFile called\n");

    NdisOpenFile(
        &status, 
        &imageFile, 
        &imageLength, 
        &FmpImageFileName, 
        highestAddress
        );

    MadgePrint1("NdisOpenFile returned\n");

    if (status != NDIS_STATUS_SUCCESS)
    {
        MadgePrint2("NdisOpenFile failed rc= %x\n", status);

        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_INVALID_DOWNLOAD_FILE_ERROR,
            2,
            initAdapter,
            MADGE_ERRMSG_OPEN_IMAGE_FILE
            );

        return NDIS_STATUS_RESOURCES;
    }

    //
    // Map in the FastMAC Plus image file.
    //

    NdisMapFile(&status, &imagePtr, imageFile);

    if (status != NDIS_STATUS_SUCCESS)
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_OUT_OF_RESOURCES,
            2,
            initAdapter,
            MADGE_ERRMSG_MAP_IMAGE_FILE
            );

        NdisCloseFile(imageFile);

        return NDIS_STATUS_RESOURCES;
    }

    //
    // Make sure that the image file is valid by checking its checksum,
    // version number and signature.
    //

    downHdrPtr = (DOWNLOAD_FILE_HEADER *) imagePtr;
    chkPtr     = ((UCHAR *) imagePtr) + DOWNLOAD_CHECKSUM_SKIP;
    chkSum     = 0;

    for (i = DOWNLOAD_CHECKSUM_SKIP; i < imageLength; i++)
    {
        DOWNLOAD_CHECKSUM_BYTE(chkSum, *chkPtr);
        chkPtr++;
    }

    if (!IS_DOWNLOAD_OK(downHdrPtr, chkSum))
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_INVALID_DOWNLOAD_FILE_ERROR,
            2,
            initAdapter,
            MADGE_ERRMSG_BAD_IMAGE_FILE
            );

        NdisUnmapFile(imageFile);
        NdisCloseFile(imageFile);

        return NDIS_STATUS_RESOURCES;
    }

    *downloadFile = imageFile;
    *download     = imagePtr;

    return NDIS_STATUS_SUCCESS;
}

#else

#include "fmplus.c"

#endif

#ifdef _M_IX86

/*---------------------------------------------------------------------------
|
| Function    - MadgeArbitrateBufferMemory
|
| Parameters  - ndisAdap -> Pointer to an NDIS3 level adapter structure.
|
| Purpose     - Determine if we can allocate all the shared memory
Ý               we need for DMA buffer space and if we can't then
Ý               reduce our requirements until we can or we reach
Ý               our minimum requirements. If the buffer space cannot
Ý               be aribtrated then the requirements are left as is and
Ý               it is assumed that the FTK initialisation will fail
Ý               and generate an out of memory error.
|
| Returns     - Nothing.
|
|--------------------------------------------------------------------------*/

STATIC VOID
MadgeArbitrateBufferMemory(PMADGE_ADAPTER ndisAdap);

#pragma FTK_INIT_FUNCTION(MadgeArbitrateBufferMemory)

STATIC VOID
MadgeArbitrateBufferMemory(PMADGE_ADAPTER ndisAdap)
{
    VOID                  * testVirt;
    VOID                  * rxVirt;
    VOID                  * txVirt;
    NDIS_PHYSICAL_ADDRESS   testPhys;
    NDIS_PHYSICAL_ADDRESS   rxPhys;
    NDIS_PHYSICAL_ADDRESS   txPhys;
    ULONG                   rxBufferSize;
    ULONG                   txBufferSize;
    UINT                    maxFrameSize;
    UINT                    rxSlots;
    UINT                    txSlots;
    BOOLEAN                 succeeded;
    BOOLEAN                 failed;
    BOOLEAN                 arbitrated;

    //
    // There doesn't seem to be a problem allocating none
    // shared memory so if we aren't in DMA mode then 
    // don't do anything.
    //

    if (ndisAdap->TransferMode != DMA_DATA_TRANSFER_MODE)
    {
        return;
    }

    //
    // The first bit of shared memory we must have is for the DMA
    // test buffers.
    //

    testVirt = NULL;

    NdisMAllocateSharedMemory(
        ndisAdap->UsedInISR.MiniportHandle,
        SCB_TEST_PATTERN_LENGTH + SSB_TEST_PATTERN_LENGTH,
        FALSE,
        &testVirt,
        &testPhys
        );

    //
    // If we can't allocate the test buffer then just give up.
    //

    if (testVirt == NULL)
    {
        return;
    }

    //
    // We've got the test buffer memory so now arbitrate the 
    // RX/TX buffers. Note: the buffer allocation MUST MATCH
    // THAT IN FTK_USER.C.
    //

    maxFrameSize = ndisAdap->MaxFrameSize;
    rxSlots      = ndisAdap->FastmacRxSlots;
    txSlots      = ndisAdap->FastmacTxSlots;

    failed       = FALSE;
    succeeded    = FALSE;
    arbitrated   = FALSE;

    while (!failed && !succeeded)
    {
        rxVirt = NULL;
        txVirt = NULL;

        //
        // Try to allocate the receive buffer.
        //

        rxBufferSize = ((maxFrameSize + 4 + 32 + 3) & ~3) * rxSlots;
        
        NdisMAllocateSharedMemory(
            ndisAdap->UsedInISR.MiniportHandle,
            rxBufferSize,
            FALSE,
            &rxVirt,
            &rxPhys
            );

        //
        // If we allocated the RX buffer space then try to allocate
        // the TX buffer space.
        //

        if (rxVirt != NULL)
        {
            txBufferSize = ((maxFrameSize + 3) & ~3) * txSlots;

            NdisMAllocateSharedMemory(
                ndisAdap->UsedInISR.MiniportHandle,
                txBufferSize,
                FALSE,
                &txVirt,
                &txPhys
                );
        }

        //
        // Free any buffers we managed to allocate.
        //

        if (rxVirt != NULL)
        {
            NdisMFreeSharedMemory(
                ndisAdap->UsedInISR.MiniportHandle,
                rxBufferSize,
                FALSE,
                rxVirt,
                rxPhys
                );
        }

        if (txVirt != NULL)
        {
            NdisMFreeSharedMemory(
                ndisAdap->UsedInISR.MiniportHandle,
                txBufferSize,
                FALSE,
                txVirt,
                txPhys
                );
        }

        //
        // If we managed to allocate both buffers then we have
        // succeeded.
        //

        if (rxVirt != NULL && txVirt != NULL)
        {
            succeeded = TRUE;
        }

        //
        // Otherwise we must reduce our memory requirements.
        //

        else
        {
            arbitrated = TRUE;

            //
            // First try reducing the number of transmit slots.
            //

            if (txSlots > FMPLUS_MIN_TX_SLOTS)
            {
                txSlots--;
            }

            //
            // Next try reducing the number of receive slots.
            //

            else if (rxSlots > FMPLUS_MIN_RX_SLOTS)
            {
                rxSlots--;
            }

            //
            // Finally try reducing the frame size. 1800 bytes has
            // empirically shown to be the minimum value required
            // for the DOMAIN server startup to work at NT installation.
            //

            else if (maxFrameSize > 1800)
            {
                maxFrameSize -= 512;

                if (maxFrameSize < 1800)
                {
                    maxFrameSize = 1800;
                }
            }

            //
            // If we can't reduce our buffer requirements any further
            // then fail.
            //

            else
            {
                failed = TRUE;
            }
        }
    }

    //
    // Free the memory for the DMA test buffer.
    //

    NdisMFreeSharedMemory(
        ndisAdap->UsedInISR.MiniportHandle,
        SCB_TEST_PATTERN_LENGTH + SSB_TEST_PATTERN_LENGTH,
        FALSE,
        testVirt,
        testPhys
        );

    //
    // If we have succeded then we must update the requirements in 
    // adapter structure and if we have changed any values we must
    // write a message to the event log.
    //

    if (succeeded && arbitrated)
    {
        ndisAdap->MaxFrameSize   = maxFrameSize;
        ndisAdap->FastmacRxSlots = rxSlots;
        ndisAdap->FastmacTxSlots = txSlots;

        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_ADAPTER_NOT_FOUND,
            1,
            initAdapter
            );
    }
}

#endif


/*---------------------------------------------------------------------------
|
| Function    - MadgeInitAdapter
|
| Parameters  - ndisAdap -> Pointer to an NDIS3 level adapter structure.
|
| Purpose     - Initialise an adapter.
|
| Returns     - An NDIS3 status code.
|
|--------------------------------------------------------------------------*/

STATIC NDIS_STATUS
MadgeInitAdapter(PMADGE_ADAPTER ndisAdap);

#pragma FTK_INIT_FUNCTION(MadgeInitAdapter)

STATIC NDIS_STATUS
MadgeInitAdapter(PMADGE_ADAPTER ndisAdap)
{
    WORD         ftkStatus;
    NDIS_STATUS  status;
    PREPARE_ARGS prepare;
    START_ARGS   start;

#ifndef LINK_FMPLUS

    NDIS_HANDLE  imageFile;
    PVOID        imagePtr;

#endif

    MadgePrint1("MadgeInitAdapter started\n");

    //
    // If we are doing MMIO then we need to map in the MMIO memory.
    // If we fail to map in the memory then default ti PIO.
    //

    if (ndisAdap->TransferMode == MMIO_DATA_TRANSFER_MODE)
    {
        if (MadgeMapMmioMemory(ndisAdap) != NDIS_STATUS_SUCCESS)
        {
            ndisAdap->TransferMode = PIO_DATA_TRANSFER_MODE;
        }
    }

#ifdef _M_IX86

    //
    // Arbitrate "DMA" buffer memory.
    //

    MadgeArbitrateBufferMemory(ndisAdap);

#endif

    //
    // Set up the arguments to pass to driver_prepare_adapter.
    //

    MADGE_ZERO_MEMORY(&prepare, sizeof(PREPARE_ARGS));

    prepare.user_information   = (void *) ndisAdap;
    prepare.number_of_rx_slots = (WORD) ndisAdap->FastmacRxSlots;
    prepare.number_of_tx_slots = (WORD) ndisAdap->FastmacTxSlots;
    prepare.max_frame_size     = (WORD) ndisAdap->MaxFrameSize;

    //
    // Try to prepare the adapter for use.
    //

    //
    // Mark the fact that the FTK has been called, so that we know if we
    // have to call driver_remove_adapter() when doing clean up.
    //

    ndisAdap->FtkInitialized = TRUE;

    MadgePrint1("driver_prepare_adapter called\n");

    if (!driver_prepare_adapter(&prepare, &(ndisAdap->FtkAdapterHandle)))
    {
	return NDIS_STATUS_FAILURE;
    }

    MadgePrint1("driver_prepare_adapter returned\n");
    MadgePrint2("adapter_handle = %d\n", ndisAdap->FtkAdapterHandle);

#ifndef LINK_FMPLUS

    //
    // Read in the download file.
    //

    status = MadgeReadDownload(ndisAdap, &imageFile, &imagePtr);

    if (status != NDIS_STATUS_SUCCESS)
    {
        return status;
    }

#endif

    //
    // Set up the arguments to driver_start_adapter.
    //

    MADGE_ZERO_MEMORY(&start, sizeof(START_ARGS));

    start.adapter_card_bus_type = (UINT) ndisAdap->FTKCardBusType;

    start.io_location           = (WORD) ndisAdap->IoLocation1;
    start.transfer_mode         = (UINT) ndisAdap->TransferMode;
    start.dma_channel           = (WORD) ndisAdap->DmaChannel;
    start.interrupt_number      = (WORD) ndisAdap->UsedInISR.InterruptNumber;
    start.set_dma_channel       = TRUE;
    start.set_interrupt_number  = TRUE;
    start.mmio_base_address     = (DWORD) ndisAdap->MmioVirtualAddress;
    start.pci_handle            = (DWORD) ndisAdap->SlotNumber;

    if (ndisAdap->Force16)
    {
        start.set_ring_speed = 16;
    }
    else if (ndisAdap->Force4)
    {
        start.set_ring_speed = 4;
    }

    start.opening_node_address = ndisAdap->OpeningNodeAddress;
    start.auto_open_option     = TRUE;

    if (ndisAdap->ForceOpen)
    {
        ndisAdap->OpenOptions |= OPEN_OPT_FORCE_OPEN;
    }

    start.open_options      = (WORD) ndisAdap->OpenOptions;

    start.rx_tx_buffer_size = (WORD) ndisAdap->CardBufferSize;

#ifndef LINK_FMPLUS

    start.code = (DOWNLOAD_IMAGE *) 
                     (((UCHAR *) imagePtr) + sizeof(DOWNLOAD_FILE_HEADER));

#else

    start.code = (DOWNLOAD_IMAGE *) fmplus_image;

#endif

    MadgePrint1("driver_start_adapter called\n");

    ftkStatus = driver_start_adapter(
                    ndisAdap->FtkAdapterHandle,
                    &start,
                    &ndisAdap->PermanentNodeAddress
                    );

    MadgePrint1("driver_start_adapter returned\n");
    MadgePrint2("MAC buffer size = %d\n", 
        adapter_record[ndisAdap->FtkAdapterHandle
            ]->init_block->smart_parms.rx_tx_buffer_size
            );

#ifndef LINK_FMPLUS

    //
    // No matter what we have finished with the FastMAC Plus image file.
    //

    NdisUnmapFile(imageFile);
    NdisCloseFile(imageFile);

#endif

    if (!ftkStatus)
    {
        MadgePrint1("driver_start_adapter failed\n");

        //
        // Were it not for the fact that we are going to clean up and fail
        // as soon as we return, we ought to set the CurrentRingState to
        // NdisRingStateOpenFailure here if AutoOpen was selected.
        //

        return NDIS_STATUS_FAILURE;
    }

    //
    // Warn the user if FastMAC Plus had to reduce the frame size.
    //

    if (ndisAdap->MaxFrameSize > start.max_frame_size)
    {
        NdisWriteErrorLogEntry(
            ndisAdap->UsedInISR.MiniportHandle,
            NDIS_ERROR_CODE_UNSUPPORTED_CONFIGURATION,
            3,
            initAdapter,
            MADGE_ERRMSG_REDUCE_MAX_FSIZE,
            ndisAdap->MaxFrameSize
            );
    }

    ndisAdap->MaxFrameSize = start.max_frame_size;

    //
    // If we did not specify a locally administered address then copy the
    // permanent one across to the local one.
    //

    if (ndisAdap->OpeningNodeAddress.byte[0] == 0)
    {
        MADGE_MOVE_MEMORY(
            &ndisAdap->OpeningNodeAddress,
            &ndisAdap->PermanentNodeAddress,
            sizeof(ndisAdap->PermanentNodeAddress)
            );
    }

    //
    // Note that the adapter is open.
    //

    ndisAdap->CurrentRingState = NdisRingStateOpened;
    ndisAdap->LastOpenStatus   = start.open_status;

    //
    // Nasty hack. If we have a PciT atapter with broken dma and we are 
    // running on a multiprocessor we need set the multiprocessor safe
    // PIO flag to make sure that we don't do DIO whilst our interrupt
    // hander is running. Unfortunately we don't know if we have
    // broken DMA until after we've started the adapter.
    //  

    if (ndisAdap->Multiprocessor && 
        adapter_record[ndisAdap->FtkAdapterHandle]->mc32_config == 
            TRN_PCIT_BROKEN_DMA)
    {
        MadgePrint1("Using MP sfae PIO because of PCIT DMA.\n");
        ndisAdap->UseMPSafePIO = TRUE;
    }

    //
    // Note that we MUST start the receive process, even if we are NOT using
    // auto-open, because FastmacPlus ignores SRBs (including OPEN SRBs) if 
    // this has not been done.
    //

    driver_start_receive_process(ndisAdap->FtkAdapterHandle);

    //
    // We now need to set the product instance ID. The product instance
    // ID will be set to the contents of ftk_product_inst_id[] if we
    // issue an open SRB, but since Miniports always auto-open we 
    // need to generate a set product instance SRB to set it.
    //

    //
    // Note that we are generating a private SRB (not to be treated
    // as a normal NDIS request), generate the SRB and then wait
    // for it to finish.
    //

    ndisAdap->PrivateSrbInProgress = TRUE;

    MadgePrint1("Calling driver_set_product_instance_id\n");

    driver_set_product_instance_id(
        ndisAdap->FtkAdapterHandle, 
        NT_PRODUCT_INSTANCE_ID
        );

    MadgePrint1("Waiting for SRB to complete\n");

    while (FlagIsTrue(&ndisAdap->PrivateSrbInProgress))
		NdisMSleep(100);

    MadgePrint1("MadgeInitAdapter finished\n");

    return NDIS_STATUS_SUCCESS;
}


/*---------------------------------------------------------------------------
|
| Function    - MadgeCleanupAdapter
|
| Parameters  - ndisAdap -> Pointer to an NDIS3 level adapter structure.
|
| Purpose     - Deallocate the resources associated with an adapter.
|
| Returns     - Nothing.
|
|--------------------------------------------------------------------------*/

STATIC VOID
MadgeCleanupAdapter(PMADGE_ADAPTER ndisAdap)
{
    BOOLEAN timerOutstanding;

    MadgePrint1("MadgeCleanupAdapter 1\n");

    if (ndisAdap->TimerInitialized)
    {
        NdisMCancelTimer(&ndisAdap->WakeUpTimer, &timerOutstanding);
        NdisMCancelTimer(&ndisAdap->CompletionTimer, &timerOutstanding);
        ndisAdap->TimerInitialized = FALSE;
    }

    MadgePrint1("MadgeCleanupAdapter 2\n");

    if (ndisAdap->FtkInitialized)
    {
        rxtx_await_empty_tx_slots(ndisAdap->FtkAdapterHandle);
        driver_remove_adapter(ndisAdap->FtkAdapterHandle);
        ndisAdap->FtkInitialized = FALSE;
    }
    
    if (ndisAdap->MapRegistersAllocated > 0)
    {
  	    NdisMFreeMapRegisters(ndisAdap->UsedInISR.MiniportHandle);
  	    ndisAdap->MapRegistersAllocated = 0;
    }

    MadgePrint1("MadgeCleanupAdapter 3\n");

    if (ndisAdap->MmioMapped)
    {
        NdisMUnmapIoSpace(
            ndisAdap->UsedInISR.MiniportHandle,
            ndisAdap->MmioVirtualAddress,
            PCI_MMIO_SIZE
            );
        ndisAdap->MmioMapped = FALSE;
    }

    MadgePrint1("MadgeCleanupAdapter 4\n");

    if (ndisAdap->IORange1Initialized)
    {
        NdisMDeregisterIoPortRange(
            ndisAdap->UsedInISR.MiniportHandle,
            ndisAdap->IoLocation1 + ndisAdap->IoLocationBase,
            ndisAdap->IORange1,
            ndisAdap->MappedIOLocation1
            );
        ndisAdap->IORange1Initialized = FALSE;
    }

    MadgePrint1("MadgeCleanupAdapter 5\n");

    if (ndisAdap->IORange2Initialized)
    {
        NdisMDeregisterIoPortRange(
            ndisAdap->UsedInISR.MiniportHandle,
            ndisAdap->IoLocation2 + ndisAdap->IoLocationBase,
            ndisAdap->IORange2,
            ndisAdap->MappedIOLocation2
            );
        ndisAdap->IORange2Initialized = FALSE;
    }

    MadgePrint1("MadgeCleanupAdapter 6\n");

    if (ndisAdap->ShutdownHandlerRegistered)
    {
        NdisMDeregisterAdapterShutdownHandler(
            ndisAdap->UsedInISR.MiniportHandle
            );
        ndisAdap->ShutdownHandlerRegistered = FALSE;

        MadgePrint1("De-registered shutdown handler\n");
    }
   
    MADGE_FREE_MEMORY(ndisAdap, sizeof(MADGE_ADAPTER));
}


/***************************************************************************
*
* Function    - MadgeHalt
*
* Parameters  - adapterContext -> Pointer to our NDIS level adapter 
*                                 structure.
*
* Purpose     - Process a call from the NDIS3 wrapper to remove an
*               adapter instance.
*
* Returns     - Nothing.
*
****************************************************************************/

VOID
MadgeHalt(NDIS_HANDLE adapterContext)
{
    PMADGE_ADAPTER ndisAdap;

    MadgePrint1("MadgeHalt started\n");

    ndisAdap = PMADGE_ADAPTER_FROM_CONTEXT(adapterContext);

    //
    // The NDIS interface guarantees that all bindings are closed, i.e. all
    // MadgeCloseAdapter calls have completed successfully.
    //

    ndisAdap->HardwareStatus = NdisHardwareStatusClosing;

    MadgeCleanupAdapter(ndisAdap);

    MadgePrint1("MadgeHalt finished\n");
}


/****************************************************************************
*
* Function    - MadgeTxCompletion
*
* Parameters  - systemSpecific1 -> Unused.
*               context         -> Actually a pointer to our NDIS3 level
*                                  adapter structure.
*               systemSpecific2 -> Unused.
*               systemSpecific3 -> Unused.
*
* Purpose     - Call our TX competion routine as a result of a timer.
*
* Returns     - Nothing.
*
****************************************************************************/

VOID
MadgeTxCompletion(
    PVOID systemSpecific1,
    PVOID context,
    PVOID systemSpecific2,
    PVOID systemSpecific3
    )
{
    PMADGE_ADAPTER ndisAdap = (PMADGE_ADAPTER) context;
    
    //
    // Call the TX completion function.
    //
    
    rxtx_irq_tx_completion_check(
        ndisAdap->FtkAdapterHandle,
        adapter_record[ndisAdap->FtkAdapterHandle]
        );
}


/***************************************************************************
*
* Function    - MadgeInitialise
*
* Parameters  - openErrorStatus      -> Pointer to a holder for an open
*                                       error status.
*               selectedMediumIndex  -> Pointer to a holder for the index
*                                       of the medium selected.
*               mediumArray          -> Array of media types.
*               mediumArraySize      -> Size of the media array.
*               miniportHandle       -> Miniport adapter handle.
*               wrapperConfigContext -> Handle used when querying the 
*                                       registry.
*
* Purpose     - Carry out adapter instance initialisation.
*
* Returns     - An NDIS3 status code.
*
***************************************************************************/

NDIS_STATUS
MadgeInitialize(
    PNDIS_STATUS openErrorStatus,
    PUINT        selectedMediumIndex,
    PNDIS_MEDIUM mediumArray,
    UINT         mediumArraySize,
    NDIS_HANDLE  miniportHandle,
    NDIS_HANDLE  wrapperConfigContext
    );

#pragma FTK_INIT_FUNCTION(MadgeInitialize)

NDIS_STATUS
MadgeInitialize(
    PNDIS_STATUS openErrorStatus,
    PUINT        selectedMediumIndex,
    PNDIS_MEDIUM mediumArray,
    UINT         mediumArraySize,
    NDIS_HANDLE  miniportHandle,
    NDIS_HANDLE  wrapperConfigContext
    )
{
    NDIS_STATUS    status;
    PMADGE_ADAPTER ndisAdap;
    NDIS_HANDLE    configHandle;
    UINT           i;

    MadgePrint1("MadgeInitialize started\n");

    //
    // ---------------------------------------------------------------------
    // Check that the upper protocol knows about token ring and if
    // it does set the index.
    //

    for (i = 0; i < mediumArraySize; i++)
    {
	if (mediumArray[i] == NdisMedium802_5)
        {
	    break;
        }
    }
	
    if (i == mediumArraySize)
    {
	return NDIS_STATUS_UNSUPPORTED_MEDIA;
    }
	
    *selectedMediumIndex = i;

    //
    // ---------------------------------------------------------------------
    // Doing basic sanity checks and allocating some memory for our 
    // per-adapter structure.
    //

    if (wrapperConfigContext == NULL)
    {
        //
        // No registry config. information found by NDIS library for us.
        // We cannot proceed without it.
        //

	return NDIS_STATUS_FAILURE;
    }

    //
    // Allocate memory for the adapter structure.
    //

    MADGE_ALLOC_MEMORY(&status, &ndisAdap, sizeof(MADGE_ADAPTER));

    if (status != NDIS_STATUS_SUCCESS)
    {
        //
        // Failed to allocate adapter structure. Can't go on without it.
        //

	return status;
    }

    MADGE_ZERO_MEMORY(ndisAdap, sizeof(MADGE_ADAPTER));

    MadgePrint2("ndisAdap = %x\n", ndisAdap);

    //
    // We need the mini port handle early on.
    //

    ndisAdap->UsedInISR.MiniportHandle = miniportHandle;

    //
    // ---------------------------------------------------------------------
    // Read the registry: open the registry, read the contents, and close it
    // again. This will handle adapter parameters and LAAs, and also working
    // out various values to do with interrupt modes. 
    //

    MadgePrint1("NdisOpenConfiguration called\n");

    NdisOpenConfiguration(
        &status,
        &configHandle,
        wrapperConfigContext
        );

    MadgePrint1("NdisOpenConfiguration returned\n");

    if (status != NDIS_STATUS_SUCCESS)
    {
        MadgePrint2("NdisOpenConfiguration failed rc=%x\n", status);
	MADGE_FREE_MEMORY(ndisAdap, sizeof(MADGE_ADAPTER));
	return status;
    }

    status = MadgeReadRegistry(
                 wrapperConfigContext,
                 configHandle,
		 ndisAdap
                 );

    NdisCloseConfiguration(configHandle);

    //
    // We have gleaned all we can from the registry - was it all OK?
    //

    if (status != NDIS_STATUS_SUCCESS)
    {
        //
        // If Status is not success, it will be either NDIS_STATUS_FAILURE 
        // if a parameter was out of range, or it will be the error code
        // returned by NdisReadConfiguration().
        //

        MadgePrint2("MadgeReadRegistry failed rc = %x\n", status);
	MADGE_FREE_MEMORY(ndisAdap, sizeof(MADGE_ADAPTER));
	return status;
    }

    //
    // ---------------------------------------------------------------------
    // Having read the registry, we can initialize the rest of the fields in
    // the adapter structure. 
    // 

    #define I_DATA ActualValue.ParameterData.IntegerData

    //
    // Copy the values from the Parameter table into the per-adapter struct.
    // This is necessary because the Parameter table will be used again for
    // the next card that is added.
    //
    // Note that we handle the rx/tx slots configuration in a special way. 
    // The value of rx/tx slots is set by indexing into a table with the
    // single paramter RxTxSlots, unless RxSlots or TxSlots have been set in
    // which case these values override the values derived from RxTxSlots.
    //

    switch (MadgeParmTable.RxTxSlots.I_DATA)
    {
        case 0: 
            ndisAdap->FastmacTxSlots = 2;
            ndisAdap->FastmacRxSlots = 2;
            break;
        case 1: 
            ndisAdap->FastmacTxSlots = 3;
            ndisAdap->FastmacRxSlots = 3;
            break;
        case 2: 
            ndisAdap->FastmacTxSlots = 4;
            ndisAdap->FastmacRxSlots = 4;
            break;
        case 3: 
            ndisAdap->FastmacTxSlots = 6;
            ndisAdap->FastmacRxSlots = 6;
            break;
        case 4: 
            ndisAdap->FastmacTxSlots = 8;
            ndisAdap->FastmacRxSlots = 8;
            break;
        case 5: 
            ndisAdap->FastmacTxSlots = 10;
            ndisAdap->FastmacRxSlots = 10;
            break;
        default: 
            ndisAdap->FastmacTxSlots = 4;
            ndisAdap->FastmacRxSlots = 4;
            break;
    }

    if (MadgeParmTable.TxSlots.I_DATA != 0)
    {
        ndisAdap->FastmacTxSlots = MadgeParmTable.TxSlots.I_DATA;
    }

    if (MadgeParmTable.RxSlots.I_DATA != 0)
    {
        ndisAdap->FastmacRxSlots = MadgeParmTable.RxSlots.I_DATA;
    }

    MadgePrint3("TX slots = %d RX slots = %d\n",
        ndisAdap->FastmacTxSlots,
        ndisAdap->FastmacRxSlots
        );

    ndisAdap->MaxFrameSize      = MadgeParmTable.MaxFrameSize.I_DATA;
    ndisAdap->CardBufferSize    = MadgeParmTable.CardBufferSize.I_DATA;
    ndisAdap->PromiscuousMode   = (MadgeParmTable.PromiscuousMode.I_DATA == 1);
    ndisAdap->AlternateIo       = (MadgeParmTable.AlternateIo.I_DATA == 1);
    ndisAdap->TestAndXIDEnabled = (MadgeParmTable.TestAndXIDEnabled.I_DATA == 1);
    ndisAdap->ForceOpen         = (MadgeParmTable.ForceOpen.I_DATA == 1);
    ndisAdap->Force4            = (MadgeParmTable.Force4.I_DATA == 1);
    ndisAdap->Force16           = (MadgeParmTable.Force16.I_DATA == 1);
    ndisAdap->Multiprocessor    = (NdisSystemProcessorCount() > 1);

    if (ndisAdap->TransferMode != DMA_DATA_TRANSFER_MODE &&
        ndisAdap->Multiprocessor)
    {
        ndisAdap->UseMPSafePIO = TRUE;
    }

    //
    // If the RingSpeed parameter is present then this overrides the
    // Force4 and Force16 parameters. RingSpeed == 0 means either not
    // present or don't care. RingSpeed == 1 means 4MBits. RingSpeed == 2
    // means 16MBits.
    //

    switch (MadgeParmTable.RingSpeed.I_DATA)
    {
        case 1:
            ndisAdap->Force4  = TRUE;
            ndisAdap->Force16 = FALSE;
            break;

        case 2:
            ndisAdap->Force4  = FALSE;
            ndisAdap->Force16 = TRUE;

        default:
            break;
    }

    //
    // Initialize the rest of the Adapter structure. 
    //

    ndisAdap->UsedInISR.MiniportHandle = miniportHandle;
    ndisAdap->CurrentLookahead         = ndisAdap->MaxFrameSize - FRAME_HEADER_SIZE;
    ndisAdap->CurrentRingState         = NdisRingStateClosed;
    ndisAdap->HardwareStatus           = NdisHardwareStatusNotReady;

    //
    // These next few lines are strictly unnecessary because their fields in
    // the structure are already zero from our earlier ZERO_MEMORY() call.
    //

    ndisAdap->UsedInISR.SrbRequestCompleted = FALSE;
    ndisAdap->UsedInISR.SrbRequestStatus    = FALSE;
    ndisAdap->DprInProgress                 = FALSE;
    
    //
    // One nasty piece of hackery for Smart16 cards, whereby we must add to
    // the IoLocation 0x1000 if the Alternate switch is true.
    //

    if (ndisAdap->NTCardBusType == NdisInterfaceIsa &&
        ndisAdap->IoLocation1   >  0x3a20           &&
        ndisAdap->AlternateIo)
    {
        ndisAdap->IoLocation1 += 0x1000;
    }

    //
    // We need to know where the end of the first range of IO locations 
    // we use is.
    //

    ndisAdap->IORange1End = ndisAdap->IoLocation1 + ndisAdap->IORange1 - 1;

    //
    // ---------------------------------------------------------------------
    // We can now try to register the adapter. This involves filling in the
    // AdapterInformation structure and calling NdisRegisterAdapter(). See
    // the function MadgeRegisterAdapter for details. 
    //

    if ((status = MadgeRegisterAdapter(
                      ndisAdap,
                      wrapperConfigContext
                      )) != NDIS_STATUS_SUCCESS)
    {
        //
        // Either we failed to allocate memory for the adapter information
        // structure, or the NdisRegisterAdapter() call failed.
        //

        MadgePrint2("MadgeRegisterAdapter failed rc = %x\n", status);
	MADGE_FREE_MEMORY(ndisAdap, sizeof(MADGE_ADAPTER));
	return status;
    }

    //
    // ---------------------------------------------------------------------
    // We are now into the last stages of initialization. This is going to
    // cause to be allocated several more resources (in the form of kernel
    // objects, filter databases, FTK structures, interrupt channels, ...)
    // so from here on we have to be a lot more careful about cleaning up.
    // 

    ndisAdap->HardwareStatus = NdisHardwareStatusInitializing;

    //
    // Call the FTK to download the MAC code to the card and initialize it.
    //

    status = MadgeInitAdapter(ndisAdap);

    if (status != NDIS_STATUS_SUCCESS)
    {
        //
        // If it was an FTK generated error then log an appropriate event.
        //

        if (status == NDIS_STATUS_FAILURE)
        {
            BYTE   error_type;
            BYTE   error_value;
            char * error_message;

            driver_explain_error(
                ndisAdap->FtkAdapterHandle,
                &error_type,
                &error_value,
                &error_message
                );

            MadgePrint3("FTK error %02x, %02x\n", error_type, error_value);

            //
            // To keep Microsoft happy we will generate special error
            // messages for some of the more common error conditions.
            //

            //
            // An open error is probably because the cable isn't plugged in.
            //

            if (error_type == ERROR_TYPE_OPEN || 
                error_type == ERROR_TYPE_AUTO_OPEN)
            {
                NdisWriteErrorLogEntry(
	            ndisAdap->UsedInISR.MiniportHandle,
	            NDIS_ERROR_CODE_INVALID_VALUE_FROM_ADAPTER,
    	            4,
                    madgeInitialize,
                    MADGE_ERRMSG_INITIAL_INIT,
	            (ULONG) error_type,
	            (ULONG) error_value
                    );
            }
            else
            {
                NdisWriteErrorLogEntry(
	            ndisAdap->UsedInISR.MiniportHandle,
	            NDIS_ERROR_CODE_HARDWARE_FAILURE,
		    4,
                    madgeInitialize,
                    MADGE_ERRMSG_INITIAL_INIT,
		    (ULONG) error_type,
		    (ULONG) error_value
                    );
            }
        }

        //
        // In any case, tidy up the adapter and abort.
        //

        MadgeCleanupAdapter(ndisAdap);
	return status;
    }

    ndisAdap->HardwareStatus = NdisHardwareStatusReady;

    //
    // Set up the ring status monitor function.
    //

    NdisMInitializeTimer(
        &ndisAdap->WakeUpTimer,
        ndisAdap->UsedInISR.MiniportHandle,
        (PVOID) MadgeGetAdapterStatus,
        ndisAdap
        );

    NdisMSetTimer(&ndisAdap->WakeUpTimer, EVERY_2_SECONDS);

    NdisMInitializeTimer(
        &ndisAdap->CompletionTimer,
        ndisAdap->UsedInISR.MiniportHandle,
        (PVOID) MadgeTxCompletion,
        ndisAdap
        );

    ndisAdap->TimerInitialized = TRUE;

    MadgePrint1("MadgeInitialize finished\n");

    return NDIS_STATUS_SUCCESS;
}


/***************************************************************************
*
* Function    - DriverEntry
*
* Parameters  - driverObject -> Pointer to a driver object.
*               registryPath -> Path to our configuration information in
*                               the registry.
*
* Purpose     - Carry out the driver (as opposed to adapter instance)
*               initialisation. This is the main entry point.
*
* Returns     - An NDIS3 status code.
*
***************************************************************************/

NDIS_STATUS
DriverEntry(PDRIVER_OBJECT driverObject, PUNICODE_STRING registryPath);

#pragma FTK_INIT_FUNCTION(DriverEntry)
        
NDIS_STATUS
DriverEntry(PDRIVER_OBJECT driverObject, PUNICODE_STRING registryPath)
{
    NDIS_HANDLE                   ndisWrapperHandle;
    NDIS_STATUS                   status;
    NDIS_MINIPORT_CHARACTERISTICS madgeChar;
    UINT                          i;

    MadgePrint1("DriverEntry starting\n");

    //
    // We are obliged first of all to initialize the NDIS wrapper.
    //

    MadgePrint1("NdisMInitializeWrapper called\n");

    NdisMInitializeWrapper(
        &ndisWrapperHandle,
	driverObject,
	registryPath,
	NULL
	);

    MadgePrint1("NdisMInitializeWrapper returned\n");

    //
    // Decode any hidden strings here, for use later in MacAddAdapter. This
    // only applies to PromiscuousMode support at the moment.
    //

    for (i = 0;
         i < MadgeParmTable.PromiscuousMode.Keyword.Length / 
             sizeof(*(MadgeParmTable.PromiscuousMode.Keyword.Buffer));
         i++)
    {
        MadgeParmTable.PromiscuousMode.Keyword.Buffer[i] -= HIDDEN_OFFS;
    }

    //
    // Fill in the characteristics table - this lists all the driver entry
    // points that may be called by the NDIS wrapper.
    //

    madgeChar.MajorNdisVersion             = MADGE_NDIS_MAJOR_VERSION;
    madgeChar.MinorNdisVersion             = MADGE_NDIS_MINOR_VERSION;
    madgeChar.CheckForHangHandler          = MadgeCheckForHang;
    madgeChar.DisableInterruptHandler      = MadgeDisableInterrupts;
    madgeChar.EnableInterruptHandler       = MadgeEnableInterrupts;
    madgeChar.HaltHandler                  = MadgeHalt;
    madgeChar.HandleInterruptHandler       = MadgeHandleInterrupt;
    madgeChar.InitializeHandler            = MadgeInitialize;
    madgeChar.ISRHandler                   = MadgeISR;
    madgeChar.QueryInformationHandler      = MadgeQueryInformation;
    madgeChar.ReconfigureHandler           = NULL;
    madgeChar.ResetHandler                 = MadgeReset;
    madgeChar.SendHandler                  = MadgeSend;
    madgeChar.SetInformationHandler        = MadgeSetInformation;
    madgeChar.TransferDataHandler          = MadgeTransferData;

    //
    // Register the miniport driver with NDIS library. 
    //

    MadgePrint1("NdisMRegisterMiniport called\n");

    status = NdisMRegisterMiniport(
                 ndisWrapperHandle,
                 &madgeChar,
                 sizeof(madgeChar)
                 );

    MadgePrint1("NdisMRegisterMiniport returned\n");

    if (status != NDIS_STATUS_SUCCESS)
    {
        MadgePrint2("NdisMRegisterMiniport failed rc=%x\n", status);
	NdisTerminateWrapper(ndisWrapperHandle, NULL);
	return NDIS_STATUS_FAILURE;
    }

    MadgePrint1("DriverEntry finished\n");

    return NDIS_STATUS_SUCCESS;
}


/******** End of MADGE.C ***************************************************/