summaryrefslogtreecommitdiffstats
path: root/src/VBox/ValidationKit/bootsectors/bootsector2-template-header.mac
blob: fe5eabb6e79ac3af940356ee1cb6fb554603e432 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
; $Id: bootsector2-template-header.mac $
;; @file
; bootsector2 header for multi-mode code templates.
;

;
; Copyright (C) 2007-2023 Oracle and/or its affiliates.
;
; This file is part of VirtualBox base platform packages, as
; available from https://www.virtualbox.org.
;
; This program is free software; you can redistribute it and/or
; modify it under the terms of the GNU General Public License
; as published by the Free Software Foundation, in version 3 of the
; License.
;
; This program is distributed in the hope that it will be useful, but
; WITHOUT ANY WARRANTY; without even the implied warranty of
; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
; General Public License for more details.
;
; You should have received a copy of the GNU General Public License
; along with this program; if not, see <https://www.gnu.org/licenses>.
;
; The contents of this file may alternatively be used under the terms
; of the Common Development and Distribution License Version 1.0
; (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
; in the VirtualBox distribution, in which case the provisions of the
; CDDL are applicable instead of those of the GPL.
;
; You may elect to license modified versions of this file under the
; terms and conditions of either the GPL or the CDDL or both.
;
; SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
;

;
; Check and expand the mode defines.
; One of the following must be defined:
;       - TMPL_RM    - real mode.
;       - TMPL_PE16  - 16-bit protected mode, unpaged.
;       - TMPL_PE32  - 32-bit protected mode, unpaged.
;       - TMPL_PEV86 - virtual 8086 mode under protected mode, unpaged.
;       - TMPL_PP16  - 16-bit protected mode, paged.
;       - TMPL_PP32  - 32-bit protected mode, paged.
;       - TMPL_PPV86 - virtual 8086 mode under protected mode, paged.
;       - TMPL_PAE16 - 16-bit protected mode with PAE (paged).
;       - TMPL_PAE32 - 16-bit protected mode with PAE (paged).
;       - TMPL_PAEV86- virtual 8086 mode under protected mode with PAE (paged).
;       - TMPL_LM16  - 16-bit long mode (paged).
;       - TMPL_LM32  - 32-bit long mode (paged).
;       - TMPL_LM64  - 64-bit long mode (paged).
;
; Derived indicators:
;       - TMPL_CMN_PE  = TMPL_PE16  | TMPL_PE32  | TMPL_PEV86
;       - TMPL_CMN_PP  = TMPL_PP16  | TMPL_PP32  | TMPL_PPV86
;       - TMPL_CMN_PAE = TMPL_PAE16 | TMPL_PAE32 | TMPL_PAEV86
;       - TMPL_CMN_LM  = TMPL_LM16  | TMPL_LM32  | TMPL_LM64
;       - TMPL_CMN_V86 = TMPL_PEV86 | TMPL_PPV86 | TMPL_PAEV86
;       - TMPL_CMN_R86 = TMPL_CMN_V86 | TMPL_RM
;
%ifdef TMPL_RM
 %ifdef TMPL_PE16
  %error "Both 'TMPL_RM' and 'TMPL_PE16' are defined."
 %endif
 %ifdef TMPL_PE32
  %error "Both 'TMPL_RM' and 'TMPL_PE32' are defined."
 %endif
 %ifdef TMPL_PEV86
  %error "Both 'TMPL_RM' and 'TMPL_PEV86' are defined."
 %endif
 %ifdef TMPL_PP16
  %error "Both 'TMPL_RM' and 'TMPL_PP16' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_RM' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PPV86
  %error "Both 'TMPL_RM' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_PAE16
  %error "Both 'TMPL_RM' and 'TMPL_PAE16' are defined."
 %endif
 %ifdef TMPL_PAE32
  %error "Both 'TMPL_RM' and 'TMPL_PAE32' are defined."
 %endif
 %ifdef TMPL_PAEV86
  %error "Both 'TMPL_RM' and 'TMPL_PAEV86' are defined."
 %endif
 %ifdef TMPL_LM16
  %error "Both 'TMPL_RM' and 'TMPL_LM16' are defined."
 %endif
 %ifdef TMPL_LM32
  %error "Both 'TMPL_RM' and 'TMPL_LM32' are defined."
 %endif
 %ifdef TMPL_LM64
  %error "Both 'TMPL_RM' and 'TMPL_LM64' are defined."
 %endif
 %define TMPL_16BIT
 %define TMPL_BITS              16
 %define TMPL_PTR_DEF           dw
 %define TMPL_NM(Name)          Name %+ _rm
 %define TMPL_NM_CMN(Name)      Name %+ _r86
 %define TMPL_MODE_STR          'real mode'
 %define TMPL_HAVE_BIOS
 %define TMPL_CMN_R86
%endif

%ifdef TMPL_PE16
 %ifdef TMPL_RM
  %error "Both 'TMPL_PE16' and 'TMPL_RM' are defined."
 %endif
 %ifdef TMPL_PE32
  %error "Both 'TMPL_PE16' and 'TMPL_PE32' are defined."
 %endif
 %ifdef TMPL_PEV86
  %error "Both 'TMPL_RM' and 'TMPL_PEV86' are defined."
 %endif
 %ifdef TMPL_PP16
  %error "Both 'TMPL_PE16' and 'TMPL_PP16' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_PE16' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PPV86
  %error "Both 'TMPL_PE16' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_PAE16
  %error "Both 'TMPL_PE16' and 'TMPL_PAE16' are defined."
 %endif
 %ifdef TMPL_PAE32
  %error "Both 'TMPL_PE16' and 'TMPL_PAE32' are defined."
 %endif
 %ifdef TMPL_PAEV86
  %error "Both 'TMPL_PE32' and 'TMPL_PAEV86' are defined."
 %endif
 %ifdef TMPL_LM16
  %error "Both 'TMPL_PE16' and 'TMPL_LM16' are defined."
 %endif
 %ifdef TMPL_LM32
  %error "Both 'TMPL_PE16' and 'TMPL_LM32' are defined."
 %endif
 %ifdef TMPL_LM64
  %error "Both 'TMPL_PE16' and 'TMPL_LM64' are defined."
 %endif
 %define TMPL_CMN_PE
 %define TMPL_CMN_P16
 %define TMPL_16BIT
 %define TMPL_BITS              16
 %define TMPL_PTR_DEF           dw
 %define TMPL_NM(Name)          Name %+ _pe16
 %define TMPL_NM_CMN(Name)      Name %+ _p16
 %define TMPL_MODE_STR          '16-bit unpaged protected mode'
%endif

%ifdef TMPL_PE32
 %ifdef TMPL_RM
  %error "Both 'TMPL_PE32' and 'TMPL_RM' are defined."
 %endif
 %ifdef TMPL_PE16
  %error "Both 'TMPL_PE32' and 'TMPL_PE16' are defined."
 %endif
 %ifdef TMPL_PEV86
  %error "Both 'TMPL_PE32' and 'TMPL_PEV86' are defined."
 %endif
 %ifdef TMPL_PP16
  %error "Both 'TMPL_PE32' and 'TMPL_PP16' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_PE32' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PPV86
  %error "Both 'TMPL_PE32' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_PAE16
  %error "Both 'TMPL_PE32' and 'TMPL_PAE16' are defined."
 %endif
 %ifdef TMPL_PAE32
  %error "Both 'TMPL_PE32' and 'TMPL_PAE32' are defined."
 %endif
 %ifdef TMPL_PAE86
  %error "Both 'TMPL_PE32' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_LM16
  %error "Both 'TMPL_PE32' and 'TMPL_LM16' are defined."
 %endif
 %ifdef TMPL_LM32
  %error "Both 'TMPL_PE32' and 'TMPL_LM32' are defined."
 %endif
 %ifdef TMPL_LM64
  %error "Both 'TMPL_PE32' and 'TMPL_LM64' are defined."
 %endif
 %define TMPL_CMN_PE
 %define TMPL_CMN_P32
 %define TMPL_32BIT
 %define TMPL_BITS              32
 %define TMPL_PTR_DEF           dd
 %define TMPL_NM(Name)          Name %+ _pe32
 %define TMPL_NM_CMN(Name)      Name %+ _p32
 %define TMPL_MODE_STR          '32-bit unpaged protected mode'
%endif

%ifdef TMPL_PEV86
 %ifdef TMPL_RM
  %error "Both 'TMPL_PEV86' and 'TMPL_RM' are defined."
 %endif
 %ifdef TMPL_PE16
  %error "Both 'TMPL_PEV86' and 'TMPL_PE16' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_PEV86' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PP16
  %error "Both 'TMPL_PEV86' and 'TMPL_PP16' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_PEV86' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PPV86
  %error "Both 'TMPL_PEV86' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_PAE16
  %error "Both 'TMPL_PEV86' and 'TMPL_PAE16' are defined."
 %endif
 %ifdef TMPL_PAE32
  %error "Both 'TMPL_PEV86' and 'TMPL_PAE32' are defined."
 %endif
 %ifdef TMPL_PAE86
  %error "Both 'TMPL_PEV86' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_LM16
  %error "Both 'TMPL_PEV86' and 'TMPL_LM16' are defined."
 %endif
 %ifdef TMPL_LM32
  %error "Both 'TMPL_PEV86' and 'TMPL_LM32' are defined."
 %endif
 %ifdef TMPL_LM64
  %error "Both 'TMPL_PEV86' and 'TMPL_LM64' are defined."
 %endif
 %define TMPL_CMN_PE
 %define TMPL_CMN_V86
 %define TMPL_CMN_R86
 %define TMPL_16BIT
 %define TMPL_BITS              16
 %define TMPL_PTR_DEF           dw
 %define TMPL_NM(Name)          Name %+ _pev86
 %define TMPL_NM_CMN(Name)      Name %+ _r86
 %define TMPL_MODE_STR          'v8086 unpaged protected mode'
%endif

%ifdef TMPL_PP16
 %ifdef TMPL_RM
  %error "Both 'TMPL_PP16' and 'TMPL_RM' are defined."
 %endif
 %ifdef TMPL_PE16
  %error "Both 'TMPL_PP16' and 'TMPL_PE16' are defined."
 %endif
 %ifdef TMPL_PE32
  %error "Both 'TMPL_PP16' and 'TMPL_PE32' are defined."
 %endif
 %ifdef TMPL_PEV86
  %error "Both 'TMPL_PP16' and 'TMPL_PEV86' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_PP16' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PPV86
  %error "Both 'TMPL_PP32' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_PAE16
  %error "Both 'TMPL_PP16' and 'TMPL_PAE16' are defined."
 %endif
 %ifdef TMPL_PAE32
  %error "Both 'TMPL_PP16' and 'TMPL_PAE32' are defined."
 %endif
 %ifdef TMPL_PAEV86
  %error "Both 'TMPL_PP16' and 'TMPL_PAEV86' are defined."
 %endif
 %ifdef TMPL_LM16
  %error "Both 'TMPL_PP16' and 'TMPL_LM16' are defined."
 %endif
 %ifdef TMPL_LM32
  %error "Both 'TMPL_PP16' and 'TMPL_LM32' are defined."
 %endif
 %ifdef TMPL_LM64
  %error "Both 'TMPL_PP16' and 'TMPL_LM64' are defined."
 %endif
 %define TMPL_CMN_PP
 %define TMPL_CMN_P16
 %define TMPL_16BIT
 %define TMPL_BITS              16
 %define TMPL_PTR_DEF           dw
 %define TMPL_NM(Name)          Name %+ _pp16
 %define TMPL_NM_CMN(Name)      Name %+ _p16
 %define TMPL_MODE_STR          '16-bit paged protected mode'
%endif

%ifdef TMPL_PP32
 %ifdef TMPL_RM
  %error "Both 'TMPL_PP32' and 'TMPL_RM' are defined."
 %endif
 %ifdef TMPL_PE16
  %error "Both 'TMPL_PP32' and 'TMPL_PE16' are defined."
 %endif
 %ifdef TMPL_PE32
  %error "Both 'TMPL_PP32' and 'TMPL_PE32' are defined."
 %endif
 %ifdef TMPL_PEV86
  %error "Both 'TMPL_PP32' and 'TMPL_PEV86' are defined."
 %endif
 %ifdef TMPL_PP16
  %error "Both 'TMPL_PP32' and 'TMPL_PP16' are defined."
 %endif
 %ifdef TMPL_PPV86
  %error "Both 'TMPL_PP32' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_PAE16
  %error "Both 'TMPL_PP32' and 'TMPL_PAE16' are defined."
 %endif
 %ifdef TMPL_PAE32
  %error "Both 'TMPL_PP32' and 'TMPL_PAE32' are defined."
 %endif
 %ifdef TMPL_PAEV86
  %error "Both 'TMPL_PP32' and 'TMPL_PAEV86' are defined."
 %endif
 %ifdef TMPL_LM16
  %error "Both 'TMPL_PP32' and 'TMPL_LM16' are defined."
 %endif
 %ifdef TMPL_LM32
  %error "Both 'TMPL_PP32' and 'TMPL_LM32' are defined."
 %endif
 %ifdef TMPL_LM64
  %error "Both 'TMPL_PP32' and 'TMPL_LM64' are defined."
 %endif
 %define TMPL_CMN_PP
 %define TMPL_CMN_P32
 %define TMPL_32BIT
 %define TMPL_BITS              32
 %define TMPL_PTR_DEF           dd
 %define TMPL_NM(Name)          Name %+ _pp32
 %define TMPL_NM_CMN(Name)      Name %+ _p32
 %define TMPL_MODE_STR          '32-bit paged protected mode'
%endif

%ifdef TMPL_PPV86
 %ifdef TMPL_RM
  %error "Both 'TMPL_PPV86' and 'TMPL_RM' are defined."
 %endif
 %ifdef TMPL_PE16
  %error "Both 'TMPL_PPV86' and 'TMPL_PE16' are defined."
 %endif
 %ifdef TMPL_PE32
  %error "Both 'TMPL_PPV86' and 'TMPL_PE32' are defined."
 %endif
 %ifdef TMPL_PEV86
  %error "Both 'TMPL_PPV86' and 'TMPL_PEV86' are defined."
 %endif
 %ifdef TMPL_PP16
  %error "Both 'TMPL_PPV86' and 'TMPL_PP16' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_PPV86' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PAE16
  %error "Both 'TMPL_PPV86' and 'TMPL_PAE16' are defined."
 %endif
 %ifdef TMPL_PAE32
  %error "Both 'TMPL_PPV86' and 'TMPL_PAE32' are defined."
 %endif
 %ifdef TMPL_PAEV86
  %error "Both 'TMPL_PPV86' and 'TMPL_PAEV86' are defined."
 %endif
 %ifdef TMPL_LM16
  %error "Both 'TMPL_PPV86' and 'TMPL_LM16' are defined."
 %endif
 %ifdef TMPL_LM32
  %error "Both 'TMPL_PPV86' and 'TMPL_LM32' are defined."
 %endif
 %ifdef TMPL_LM64
  %error "Both 'TMPL_PPV86' and 'TMPL_LM64' are defined."
 %endif
 %define TMPL_CMN_PP
 %define TMPL_CMN_V86
 %define TMPL_CMN_R86
 %define TMPL_16BIT
 %define TMPL_BITS              16
 %define TMPL_PTR_DEF           dw
 %define TMPL_NM(Name)          Name %+ _ppv86
 %define TMPL_NM_CMN(Name)      Name %+ _r86
 %define TMPL_MODE_STR          'v8086 paged protected mode'
%endif

%ifdef TMPL_PAE16
 %ifdef TMPL_RM
  %error "Both 'TMPL_PAE16' and 'TMPL_RM' are defined."
 %endif
 %ifdef TMPL_PE16
  %error "Both 'TMPL_PAE16' and 'TMPL_PE16' are defined."
 %endif
 %ifdef TMPL_PE32
  %error "Both 'TMPL_PAE16' and 'TMPL_PE32' are defined."
 %endif
 %ifdef TMPL_PEV86
  %error "Both 'TMPL_PAE16' and 'TMPL_PEV86' are defined."
 %endif
 %ifdef TMPL_PP16
  %error "Both 'TMPL_PAE16' and 'TMPL_PP16' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_PAE16' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PPV86
  %error "Both 'TMPL_PAE16' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_PAE32
  %error "Both 'TMPL_PAE16' and 'TMPL_PAE32' are defined."
 %endif
 %ifdef TMPL_LM16
  %error "Both 'TMPL_PAE16' and 'TMPL_LM16' are defined."
 %endif
 %ifdef TMPL_PAEV86
  %error "Both 'TMPL_PAE16' and 'TMPL_PAEV86' are defined."
 %endif
 %ifdef TMPL_LM32
  %error "Both 'TMPL_PAE16' and 'TMPL_LM32' are defined."
 %endif
 %ifdef TMPL_LM64
  %error "Both 'TMPL_PAE16' and 'TMPL_LM64' are defined."
 %endif
 %define TMPL_CMN_PAE
 %define TMPL_16BIT
 %define TMPL_CMN_P16
 %define TMPL_BITS              16
 %define TMPL_PTR_DEF           dw
 %define TMPL_NM(Name)          Name %+ _pae16
 %define TMPL_NM_CMN(Name)      Name %+ _p16
 %define TMPL_MODE_STR          '16-bit pae protected mode'
%endif

%ifdef TMPL_PAE32
 %ifdef TMPL_RM
  %error "Both 'TMPL_PAE32' and 'TMPL_RM' are defined."
 %endif
 %ifdef TMPL_PE16
  %error "Both 'TMPL_PAE32' and 'TMPL_PE16' are defined."
 %endif
 %ifdef TMPL_PE32
  %error "Both 'TMPL_PAE32' and 'TMPL_PE32' are defined."
 %endif
 %ifdef TMPL_PEV86
  %error "Both 'TMPL_PAE32' and 'TMPL_PEV86' are defined."
 %endif
 %ifdef TMPL_PP16
  %error "Both 'TMPL_PAE32' and 'TMPL_PP16' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_PAE32' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PPV86
  %error "Both 'TMPL_PAE32' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_PAE16
  %error "Both 'TMPL_PAE32' and 'TMPL_PAE16' are defined."
 %endif
 %ifdef TMPL_PAEV86
  %error "Both 'TMPL_PAE32' and 'TMPL_PAEV86' are defined."
 %endif
 %ifdef TMPL_LM16
  %error "Both 'TMPL_PAE32' and 'TMPL_LM16' are defined."
 %endif
 %ifdef TMPL_LM32
  %error "Both 'TMPL_PAE32' and 'TMPL_LM32' are defined."
 %endif
 %ifdef TMPL_LM64
  %error "Both 'TMPL_PAE32' and 'TMPL_LM64' are defined."
 %endif
 %define TMPL_CMN_PAE
 %define TMPL_CMN_P32
 %define TMPL_32BIT
 %define TMPL_BITS              32
 %define TMPL_PTR_DEF           dd
 %define TMPL_NM(Name)          Name %+ _pae32
 %define TMPL_NM_CMN(Name)      Name %+ _p32
 %define TMPL_MODE_STR          '32-bit pae protected mode'
%endif

%ifdef TMPL_PAEV86
 %ifdef TMPL_RM
  %error "Both 'TMPL_PAEV86' and 'TMPL_RM' are defined."
 %endif
 %ifdef TMPL_PE16
  %error "Both 'TMPL_PAEV86' and 'TMPL_PE16' are defined."
 %endif
 %ifdef TMPL_PE32
  %error "Both 'TMPL_PAEV86' and 'TMPL_PE32' are defined."
 %endif
 %ifdef TMPL_PEV86
  %error "Both 'TMPL_PAEV86' and 'TMPL_PEV86' are defined."
 %endif
 %ifdef TMPL_PP16
  %error "Both 'TMPL_PAEV86' and 'TMPL_PP16' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_PAEV86' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PPV86
  %error "Both 'TMPL_PAEV86' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_PAE16
  %error "Both 'TMPL_PAEV86' and 'TMPL_PAE16' are defined."
 %endif
 %ifdef TMPL_PAEV86
  %error "Both 'TMPL_PAEV86' and 'TMPL_PAEV86' are defined."
 %endif
 %ifdef TMPL_LM16
  %error "Both 'TMPL_PAEV86' and 'TMPL_LM16' are defined."
 %endif
 %ifdef TMPL_LM32
  %error "Both 'TMPL_PAEV86' and 'TMPL_LM32' are defined."
 %endif
 %ifdef TMPL_LM64
  %error "Both 'TMPL_PAEV86' and 'TMPL_LM64' are defined."
 %endif
 %define TMPL_CMN_PAE
 %define TMPL_CMN_V86
 %define TMPL_CMN_R86
 %define TMPL_16BIT
 %define TMPL_BITS              16
 %define TMPL_PTR_DEF           dw
 %define TMPL_NM(Name)          Name %+ _paev86
 %define TMPL_NM_CMN(Name)      Name %+ _r86
 %define TMPL_MODE_STR          'v8086 pae protected mode'
%endif

%ifdef TMPL_LM16
 %ifdef TMPL_RM
  %error "Both 'TMPL_LM16' and 'TMPL_RM' are defined."
 %endif
 %ifdef TMPL_PE16
  %error "Both 'TMPL_LM16' and 'TMPL_PE16' are defined."
 %endif
 %ifdef TMPL_PE32
  %error "Both 'TMPL_LM16' and 'TMPL_PE32' are defined."
 %endif
 %ifdef TMPL_PEV86
  %error "Both 'TMPL_LM16' and 'TMPL_PEV86' are defined."
 %endif
 %ifdef TMPL_PP16
  %error "Both 'TMPL_LM16' and 'TMPL_PP16' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_LM16' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PPV86
  %error "Both 'TMPL_LM16' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_PAE16
  %error "Both 'TMPL_LM16' and 'TMPL_PAE16' are defined."
 %endif
 %ifdef TMPL_PAE32
  %error "Both 'TMPL_LM16' and 'TMPL_PAE32' are defined."
 %endif
 %ifdef TMPL_PAEV86
  %error "Both 'TMPL_LM16' and 'TMPL_PAEV86' are defined."
 %endif
 %ifdef TMPL_LM32
  %error "Both 'TMPL_LM16' and 'TMPL_LM32' are defined."
 %endif
 %ifdef TMPL_LM64
  %error "Both 'TMPL_LM16' and 'TMPL_LM64' are defined."
 %endif
 %define TMPL_CMN_LM
 %define TMPL_CMN_P16
 %define TMPL_16BIT
 %define TMPL_BITS              16
 %define TMPL_PTR_DEF           dw
 %define TMPL_NM(Name)          Name %+ _lm16
 %define TMPL_NM_CMN(Name)      Name %+ _p16
 %define TMPL_MODE_STR          '16-bit long mode'
%endif

%ifdef TMPL_LM32
 %ifdef TMPL_RM
  %error "Both 'TMPL_LM32' and 'TMPL_RM' are defined."
 %endif
 %ifdef TMPL_PE16
  %error "Both 'TMPL_LM32' and 'TMPL_PE16' are defined."
 %endif
 %ifdef TMPL_PE32
  %error "Both 'TMPL_LM32' and 'TMPL_PE32' are defined."
 %endif
 %ifdef TMPL_PEV86
  %error "Both 'TMPL_LM32' and 'TMPL_PEV86' are defined."
 %endif
 %ifdef TMPL_PP16
  %error "Both 'TMPL_LM32' and 'TMPL_PP16' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_LM32' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PPV86
  %error "Both 'TMPL_LM32' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_PAE16
  %error "Both 'TMPL_LM32' and 'TMPL_PAE16' are defined."
 %endif
 %ifdef TMPL_PAE32
  %error "Both 'TMPL_LM32' and 'TMPL_PAE32' are defined."
 %endif
 %ifdef TMPL_PAEV86
  %error "Both 'TMPL_LM32' and 'TMPL_PAEV86' are defined."
 %endif
 %ifdef TMPL_LM16
  %error "Both 'TMPL_LM32' and 'TMPL_LM16' are defined."
 %endif
 %ifdef TMPL_LM64
  %error "Both 'TMPL_LM32' and 'TMPL_LM64' are defined."
 %endif
 %define TMPL_CMN_LM
 %define TMPL_CMN_P32
 %define TMPL_32BIT
 %define TMPL_BITS              32
 %define TMPL_PTR_DEF           dd
 %define TMPL_NM(Name)          Name %+ _lm32
 %define TMPL_NM_CMN(Name)      Name %+ _p32
 %define TMPL_MODE_STR          '32-bit long mode'
%endif

%ifdef TMPL_LM64
 %ifdef TMPL_RM
  %error ""Both 'TMPL_LM64' and 'TMPL_RM' are defined.""
 %endif
 %ifdef TMPL_PE16
  %error "Both 'TMPL_LM64' and 'TMPL_PE16' are defined."
 %endif
 %ifdef TMPL_PE32
  %error "Both 'TMPL_LM64' and 'TMPL_PE32' are defined."
 %endif
 %ifdef TMPL_PEV86
  %error "Both 'TMPL_LM64' and 'TMPL_PEV86' are defined."
 %endif
 %ifdef TMPL_PP16
  %error "Both 'TMPL_LM64' and 'TMPL_PP16' are defined."
 %endif
 %ifdef TMPL_PP32
  %error "Both 'TMPL_LM64' and 'TMPL_PP32' are defined."
 %endif
 %ifdef TMPL_PPV86
  %error "Both 'TMPL_LM64' and 'TMPL_PPV86' are defined."
 %endif
 %ifdef TMPL_PAE16
  %error "Both 'TMPL_LM64' and 'TMPL_PAE16' are defined."
 %endif
 %ifdef TMPL_PAE32
  %error "Both 'TMPL_LM64' and 'TMPL_PAE32' are defined."
 %endif
 %ifdef TMPL_PAEV86
  %error "Both 'TMPL_LM64' and 'TMPL_PAEV86' are defined."
 %endif
 %ifdef TMPL_LM16
  %error "Both 'TMPL_LM64' and 'TMPL_LM16' are defined."
 %endif
 %ifdef TMPL_LM32
  %error "Both 'TMPL_LM64' and 'TMPL_LM32' are defined."
 %endif
 %define TMPL_CMN_LM
 %define TMPL_CMN_P64
 %define TMPL_64BIT
 %define TMPL_BITS              64
 %define TMPL_PTR_DEF           dq
 %define TMPL_NM(Name)          Name %+ _lm64
 %define TMPL_NM_CMN(Name)      Name %+ _p64
 %define TMPL_MODE_STR          '64-bit long mode'
%endif

%ifndef TMPL_MODE_STR
 %error "internal error"
%endif


;
; Register aliases.
;
%ifdef TMPL_64BIT
 %define xCB  8
 %define xDEF dq
 %define xRES resq
 %define xPRE qword
 %define xSP  rsp
 %define xBP  rbp
 %define xAX  rax
 %define xBX  rbx
 %define xCX  rcx
 %define xDX  rdx
 %define xDI  rdi
 %define xSI  rsi
 %define xWrtRIP wrt rip
 %define xPUSHF pushq
 %define xPOPF  popfq
%else
 %ifdef TMPL_32BIT
  %define xCB  4
  %define xDEF dd
  %define xRES resd
  %define xPRE dword
  %define xSP  esp
  %define xBP  ebp
  %define xAX  eax
  %define xBX  ebx
  %define xCX  ecx
  %define xDX  edx
  %define xDI  edi
  %define xSI  esi
  %define xWrtRIP
  %define xPUSHF pushfd
  %define xPOPF  popfd
 %else
  %ifndef TMPL_16BIT
   %error "TMPL_XXBIT is not defined."
  %endif
  %define xCB  2
  %define xDEF dw
  %define xRES resw
  %define xPRE word
  %define xSP  sp
  %define xBP  bp
  %define xAX  ax
  %define xBX  bx
  %define xCX  cx
  %define xDX  dx
  %define xDI  di
  %define xSI  si
  %define xWrtRIP
  %define xPUSHF pushf
  %define xPOPF  popf
 %endif
%endif

;
; Register names corresponding to the max size for pop/push <reg>.
;
; 16-bit can push both 32-bit and 16-bit registers.  This 's' prefixed variant
; is used when 16-bit should use the 32-bit register.
;
%ifdef TMPL_64BIT
 %define sCB  8
 %define sDEF dq
 %define sRES resq
 %define sPRE qword
 %define sSP  rsp
 %define sBP  rbp
 %define sAX  rax
 %define sBX  rbx
 %define sCX  rcx
 %define sDX  rdx
 %define sDI  rdi
 %define sSI  rsi
 %define sPUSHF pushfq
 %define sPOPF  popfq
%else
 %define sCB  4
 %define sDEF dd
 %define sRES resd
 %define sPRE dword
 %define sSP  esp
 %define sBP  ebp
 %define sAX  eax
 %define sBX  ebx
 %define sCX  ecx
 %define sDX  edx
 %define sDI  edi
 %define sSI  esi
 %define sPUSHF pushfd
 %define sPOPF  popfd
%endif

;
; Default code segment.
;
%ifdef TMPL_64BIT
 %define TMPL_BEGINCODE BEGINCODEHIGH
%elifdef TMPL_32BIT
 %define TMPL_BEGINCODE BEGINCODEHIGH
%elifdef TMPL_16BIT
 %define TMPL_BEGINCODE BEGINCODELOW
%else
 %error "Missing TMPL_xxBIT!"
%endif
TMPL_BEGINCODE

;
; Change the bitness.
;
%ifdef TMPL_64BIT
BITS 64
%else
 %ifdef TMPL_32BIT
BITS 32
 %else
BITS 16
 %endif
%endif